Clean Code in C#: Prinzipien und Beispiele für Anfänger

Clean Code in C#: Der Weg zu professionellem Code

Jeder Entwickler träumt davon, Code zu schreiben, der nicht nur funktioniert, sondern auch leicht lesbar, wartbar und erweiterbar ist. Das Konzept von "Clean Code", popularisiert von Robert Martin, ist nicht nur eine Reihe von Regeln, sondern eine Philosophie der Professionalität. In diesem Artikel werden wir die wichtigsten Prinzipien von Clean Code in Bezug auf die Sprache C# und die Plattform .NET anhand einfacher und verständlicher Beispiele für Anfänger analysieren. Sie werden erfahren, wie Sie "schmutzigen" Code in eine elegante und zuverlässige Lösung verwandeln.

1. Aussagekräftige Namen: Der erste Schritt zur Sauberkeit

Der wichtigste Teil von sauberem Code ist die Benennung. Der Name einer Variable, Methode, Klasse oder Schnittstelle sollte die Fragen "Was ist das?" oder "Was macht es?" beantworten. Gute Namen ersparen die Notwendigkeit, Kommentare zu schreiben.

Schlechte und gute Beispiele

Vermeiden Sie einbuchstabige Abkürzungen (außer für Schleifenzähler) und abstrakte Bezeichnungen.

// SCHLECHT: Unverständliche Namenint d; // vergangene Zeit in TagenList<string> l = new List<string>();

public void Proc(int x) {    // ...}

// GUT: Aussagekräftige Namenint elapsedTimeInDays;List<string> customerNames = new List<string>();

public void ProcessOrder(int orderId){    // ...}

Regeln für C#:

• Klassen und Methoden — PascalCase (z.B. OrderService, CalculateTotal).
• Lokale Variablen und Parameter — camelCase (z.B. orderId, customerName).
• Schnittstellen — beginnen mit dem Buchstaben I (z.B. IRepository).
• Vermeiden Sie "ungarische Notation" (wie strName). Der Variablentyp sollte aus dem Kontext ersichtlich sein.

2. Funktionen: Klein und erledigen eine Sache

Eine Funktion (oder Methode) sollte klein sein und nur eine Aufgabe erledigen (Single Responsibility Principle auf Methodenebene). Wenn eine Funktion mehrere Dinge tut, sollte sie in kleinere aufgeteilt werden.

Refactoring einer großen Funktion

Stellen Sie sich vor, wir müssen eine Bestellung speichern und eine Benachrichtigung senden. Schlechter Code macht alles auf einmal.

// SCHLECHT: Funktion macht zu vielpublic void SaveOrderAndNotify(Order order){    // 1. Validierung    if (order.Items.Count == 0) throw new Exception("Leere Bestellung");

    // 2. Speichern in der DB (hypothetisch)    Console.WriteLine($"Bestellung {order.Id} gespeichert.");

    // 3. E-Mail senden    Console.WriteLine($"Benachrichtigung an {order.CustomerEmail} gesendet.");}

// GUT: Aufteilung in kleine Funktionenpublic void ProcessOrder(Order order){    ValidateOrder(order);    SaveOrder(order);    SendOrderConfirmation(order);}

private void ValidateOrder(Order order){    if (order.Items.Count == 0)        throw new InvalidOperationException("Eine leere Bestellung kann nicht verarbeitet werden.");}

private void SaveOrder(Order order){    // Speicherlogik    Console.WriteLine($"Bestellung {order.Id} gespeichert.");}

private void SendOrderConfirmation(Order order){    // Sende-Logik    Console.WriteLine($"Benachrichtigung an {order.CustomerEmail} gesendet.");}

Tipp: Versuchen Sie, dass das Abstraktionsniveau innerhalb einer Funktion gleich ist. Mischen Sie nicht Datenbankarbeit und Textformatierung in einer Methode.

3. Fehler- und Ausnahmebehandlung

Sauberer Code behandelt Fehler vorhersagbar. In C# werden dafür Ausnahmen verwendet. Vermeiden Sie die Rückgabe von "magischen Zahlen" (z.B. -1) oder null zur Kennzeichnung eines Fehlers.

// SCHLECHT: Rückgabe von null bei Fehlerpublic User FindUser(int id){    if (id <= 0) return null; // Was soll der aufrufende Code tun?    // ... Suche    return n