Clean Code

Kurz: Clean Code bezeichnet Quelltext, der leicht zu lesen, zu verstehen und zu ändern ist. Er entsteht durch aussagekräftige Namen, kleine Funktionen, klare Struktur und wenig Duplikate.

Genauer: Code wird deutlich öfter gelesen als geschrieben – deshalb zahlt sich Lesbarkeit aus. Der Begriff geht auf das Buch von Robert C. Martin zurück. Die Regeln sind Richtlinien, keine Gesetze; im Team zählen gemeinsame Konventionen mehr als persönlicher Geschmack.

Im Detail

Die wichtigsten Regeln

• Sprechende Namen: anzahlOffeneBestellungen statt n, istVolljaehrig() statt check().
• Kleine Funktionen mit einer Aufgabe: Eine Funktion tut eines, tut es gut und hat wenige Parameter (idealerweise höchstens drei).
• Keine Duplikate (DRY): Wiederholte Logik gehört in eine Funktion.
• Kommentare erklären das Warum, nicht das Was; schlechter Code wird besser umgeschrieben als kommentiert.
• Flache Verschachtelung: Früh zurückkehren (guard clauses), statt tief verschachtelter if-Blöcke.
• Keine Magic Numbers: MAX_VERSUCHE = 3 statt einer nackten 3.
• Konsistente Formatierung: Formatierer (Prettier, Black, gofmt) nehmen Diskussionen ab.

# vorher
def f(x, t):
    if t == 1:
        return x * 0.19
    else:
        if t == 2:
            return x * 0.07
        else:
            return 0
 
# nachher
STEUERSAETZE = {"normal": 0.19, "ermaessigt": 0.07}
 
def mehrwertsteuer(betrag, art):
    return betrag * STEUERSAETZE.get(art, 0)

Werkzeuge

Linter (ESLint, Pylint, Ruff), Formatierer und statische Analyse zeigen Probleme automatisch an; Code-Reviews sichern die Qualität im Team. Zum Verbessern bestehenden Codes dient das Refactoring; die SOLID-Prinzipien geben Hinweise für die Struktur objektorientierter Programme.

Siehe auch: Refactoring, SOLID, Code-Review, Debugging