Clean Code: Lesbaren Code schreiben
Code wird öfter gelesen als geschrieben. Hier lernst du die wichtigsten Clean-Code-Prinzipien: sprechende Namen, kleine Funktionen, DRY und sinnvolle Kommentare.
Code schreibst du einmal, gelesen wird er dutzende Male – von Kolleginnen, Kollegen und vor allem von deinem zukünftigen Ich. Genau deshalb lohnt es sich, von Anfang an lesbaren Code zu schreiben. In diesem Beitrag stelle ich dir die wichtigsten Clean-Code-Prinzipien vor, die deinen Code klarer und wartbarer machen.
Sprechende Namen wählen
Der wohl wichtigste Hebel sind gute Namen. Ein Name sollte verraten, was eine Variable enthält oder was eine Funktion tut – ohne dass man den Code dahinter lesen muss. Vergleiche selbst:
// Schlecht: nichtssagend
const d = 86400;
function calc(x) { return x * d; }
// Gut: selbsterklärend
const SEKUNDEN_PRO_TAG = 86400;
function tageInSekunden(tage) {
return tage * SEKUNDEN_PRO_TAG;
}Spar nicht an Buchstaben. Ein längerer, klarer Name ist immer besser als ein kurzes Kürzel, das niemand versteht.
Funktionen klein halten
Eine Funktion sollte genau eine Aufgabe erledigen. Macht sie zu viel, wird sie schwer zu verstehen und zu testen. Eine gute Faustregel: Wenn du im Funktionsnamen ein "und" brauchst, mach zwei Funktionen daraus.
// Schlecht: macht zu viel auf einmal
function verarbeiteBestellung(b) {
// validieren, Preis berechnen, E-Mail senden ...
}
// Gut: klar getrennte Aufgaben
function istBestellungGueltig(bestellung) { /* ... */ }
function berechneGesamtpreis(bestellung) { /* ... */ }
function sendeBestaetigung(bestellung) { /* ... */ }Kleine Funktionen lassen sich einzeln testen, wiederverwenden und leichter benennen.
DRY: Wiederholungen vermeiden
DRY steht für "Don't Repeat Yourself". Tauchst derselbe Code an mehreren Stellen auf, wird Wartung zum Albtraum: Eine Änderung musst du überall nachziehen. Fasse Wiederholungen in einer Funktion zusammen:
// Schlecht: dreimal fast dasselbe
const netto1 = preis1 * 1.19;
const netto2 = preis2 * 1.19;
const netto3 = preis3 * 1.19;
// Gut: eine Quelle der Wahrheit
function mitMehrwertsteuer(preis) {
return preis * 1.19;
}Ändert sich der Steuersatz, passt du nur eine Stelle an. Übertreib es aber nicht: Zwei zufällig ähnliche Zeilen müssen nicht zwingend zusammengefasst werden.
Kommentare richtig einsetzen
Guter Code erklärt sich weitgehend selbst. Kommentare sollten nicht das Was beschreiben, sondern das Warum. Ein Kommentar, der nur den Code wiederholt, ist überflüssig:
# Schlecht: erklärt das Offensichtliche
zaehler = zaehler + 1 # zaehler um eins erhoehen
# Gut: erklärt die Absicht dahinter
# Workaround: Die API zaehlt ab 0, unsere Anzeige ab 1
zaehler = zaehler + 1Die beste Dokumentation ist oft klarer Code selbst. Greife zum Kommentar, wenn eine Entscheidung sonst nicht nachvollziehbar wäre.
Früh aussteigen statt tief verschachteln
Tiefe Verschachtelungen machen Code schwer lesbar. Mit sogenannten Guard Clauses steigst du früh aus und hältst die Hauptlogik flach:
# Schlecht: tief verschachtelt
def rabatt(kunde):
if kunde is not None:
if kunde.aktiv:
return 0.1
return 0
# Gut: früh aussteigen
def rabatt(kunde):
if kunde is None:
return 0
if not kunde.aktiv:
return 0
return 0.1Die zweite Variante liest sich von oben nach unten wie eine Checkliste und kommt ohne tiefe Einrückungen aus.
Einheitlich formatieren
Konsistente Formatierung erleichtert das Lesen enorm. Lege diese Arbeit am besten Werkzeugen wie Prettier oder Black ab, statt von Hand auf Leerzeichen zu achten:
# JavaScript-Code automatisch formatieren
npx prettier --write .
# Python-Code automatisch formatieren
black .So sieht der Code im ganzen Projekt gleich aus, und in Code-Reviews diskutierst du über Inhalte statt über Einrückungen.
Fazit
Clean Code ist kein Selbstzweck, sondern eine Investition in die Zukunft – vor allem in dein eigenes zukünftiges Ich. Mit sprechenden Namen, kleinen Funktionen, dem DRY-Prinzip und sinnvollen Kommentaren wird dein Code leichter verständlich und wartbar. Guard Clauses halten die Logik flach, und automatische Formatierung sorgt für Einheitlichkeit. Nimm dir beim nächsten Mal bewusst einen dieser Punkte vor und wende ihn konsequent an – sauberer Code wird so nach und nach zur Gewohnheit.