Clean Code

Clean Code im Überblick

Clean Code ist die Praxis, Code so zu schreiben, dass er nicht nur funktioniert, sondern auch lesbar, wartbar und erweiterbar ist. Robert C. Martin (“Uncle Bob”) hat das Konzept in seinem gleichnamigen Buch popularisiert. Für KI-Projekte ist Clean Code besonders wichtig: ML-Pipelines, Daten-Preprocessing und Inferenz-Code werden schnell komplex – schlechter Code macht Debugging und Iteration extrem aufwändig.

Clean Code bedeutet, Code so zu schreiben, dass andere Entwickler (und dein zukünftiges Ich) ihn sofort verstehen. Es geht nicht um Perfektion, sondern um Klarheit.

Vorher (Dirty Code):

function p(d: any[]) {
  let r = [];
  for (let i = 0; i < d.length; i++) {
    if (d[i].s > 0.8) r.push(d[i]);
  }
  return r;
}

Nachher (Clean Code):

function filterRelevantResults(
  searchResults: SearchResult[]
): SearchResult[] {
  const RELEVANCE_THRESHOLD = 0.8;
  return searchResults.filter(
    result => result.score > RELEVANCE_THRESHOLD
  );
}

Technisch betrachtet

Die wichtigsten Prinzipien

• Sprechende Namen: getUserById() statt get(), isActive statt flag
• Kleine Funktionen: Eine Funktion = ein Zweck, max. 20-30 Zeilen
• DRY (Don’t Repeat Yourself): Keine Code-Duplikation
• KISS (Keep It Simple, Stupid): Die einfachste Lösung bevorzugen
• Boy Scout Rule: Code immer etwas besser hinterlassen

Code Smells erkennen

• Lange Funktionen: Mehr als 30 Zeilen → aufteilen
• Tiefe Verschachtelung: Mehr als 3 Ebenen → Early Returns nutzen
• Magische Zahlen: if (status === 3) → if (status === Status.ACTIVE)
• Kommentare als Pflaster: Wenn Code Kommentare braucht, ist er oft unklar
• Tote Code-Pfade: Unerreichbarer Code → löschen

Clean Code und KI

LLM-generierter Code ist oft funktional korrekt, aber nicht immer clean. Typische Probleme:

• Generische Variablennamen (data, result, temp)
• Fehlende Error-Handling-Patterns
• Übermäßige Kommentare statt selbsterklärendem Code