Was ist Clean Code?
sauberer Quellcode
Clean Code bezeichnet Quellcode, den eine andere Person ohne Rückfragen lesen und gefahrlos ändern kann. Der Begriff steht für eine Sammlung von Handwerksregeln zu Benennung, Funktionsgröße, Wiederholung und Struktur, die Robert C. Martin 2008 im gleichnamigen Buch zusammengetragen hat.
Der Code, den du heute schreibst, wird über Jahre öfter gelesen als geändert, und meistens von jemandem, der nicht dabei war, als er entstanden ist.
KI-generiertDieses Bild wurde mit KI erzeugt · Yves Hoppe / KI / cmt
- Geprägt von
- Robert C. Martin
- Setzt an bei
- Namen, Funktionsgröße, Wiederholung
- Prüfbar im
- Review, nicht über eine Kennzahl
- Verwandt mit
- Refactoring und technischer Schuld
Die Regeln, die den meisten Unterschied machen
Clean Code ist kein Standard mit Prüfsiegel, sondern eine Haltung, die sich in einer Handvoll Regeln niederschlägt. Die folgenden tragen im Alltag am meisten:
-
Sprechende Namen
Eine Variable namens d erklärt nichts, daysSinceInvoice erklärt alles und macht einen Kommentar überflüssig. Kommt im Funktionsnamen ein „und“ vor, tut die Funktion zwei Dinge.
-
Kleine Funktionen mit einer Aufgabe
Eine Funktion erledigt genau eine Sache und arbeitet auf einer Abstraktionsebene. Die äußere Funktion liest sich dann wie eine Inhaltsangabe.
-
DRY: Don’t Repeat Yourself
Jedes Wissen steht genau einmal im Code. Duplikate sind teuer, weil eine Korrektur an einer Stelle die anderen unverändert lässt.
-
KISS: Keep It Simple, Stupid
Die einfachste Lösung, die das Problem löst, schlägt die elegante, die drei künftige Fälle vorwegnimmt.
-
YAGNI: You Ain’t Gonna Need It
Du baust nur, was heute gebraucht wird. Vorratsfunktionen kosten Pflege und werden selten so gebraucht, wie sie gedacht waren.
-
Boy-Scout-Rule
Jede Datei, die du anfasst, hinterlässt du ein wenig aufgeräumter, als du sie vorgefunden hast.
Vorher und nachher: ein Beispiel
Am deutlichsten wird das Prinzip an einer kleinen Funktion, die eine Mahngebühr berechnet. Beide Fassungen tun exakt dasselbe, aber nur eine erklärt sich selbst.
# vorher
def calc(d, a):
# prüfen, ob Rechnung überfällig
if (date.today() - d).days > 30 and a > 0:
return a * 0.05
return 0
# nachher
PAYMENT_TERM_DAYS = 30
LATE_FEE_RATE = 0.05
def late_fee(invoice_date, open_amount):
if open_amount <= 0 or not is_overdue(invoice_date):
return 0
return open_amount * LATE_FEE_RATE
def is_overdue(invoice_date):
return (date.today() - invoice_date).days > PAYMENT_TERM_DAYS Die zweite Fassung ist länger, aber jede Zeile beantwortet eine Frage, die sich beim Lesen sonst stellen würde: Was bedeuten 30 und 0,05? Was ist d? Ab wann gilt eine Rechnung als überfällig? Der Kommentar ist verschwunden, weil der Funktionsname is_overdue dasselbe sagt und beim nächsten Umbau nicht veralten kann. Ändert sich das Zahlungsziel, gibt es genau eine Stelle dafür.
SOLID: die Prinzipien für Klassen und Module
Für den Schnitt größerer Einheiten hat Robert C. Martin fünf Entwurfsprinzipien zusammengefasst, die unter dem Kürzel SOLID bekannt sind. Sie gehören zum Kern dessen, was in Schulungen und Büchern unter Clean Code verstanden wird.
| Prinzip | Kurz gesagt |
|---|---|
| Single Responsibility | Eine Klasse hat genau einen Grund, sich zu ändern. |
| Open/Closed | Offen für Erweiterung, geschlossen für Änderung. |
| Liskov Substitution | Eine Unterklasse funktioniert überall, wo die Basisklasse erwartet wird. |
| Interface Segregation | Lieber mehrere kleine Schnittstellen als eine große. |
| Dependency Inversion | Abhängig von Abstraktionen, nicht von konkreten Klassen. |
Im deutschsprachigen Raum hat die Initiative Clean Code Developer diese und weitere Prinzipien in aufeinander aufbauende Grade sortiert, die von Rot über Orange, Gelb und Grün bis Blau führen, dazu kommt ein weißer Grad, der alle vereint. Das ist kein Zertifikat, sondern ein Lernpfad, den Teams als gemeinsame Sprache nutzen.
Kommentare: wann sie helfen und wann sie ein Warnsignal sind
Ein Kommentar, der erklärt, was die nächsten Zeilen tun, beschreibt meistens eine Funktion, die noch keinen Namen hat. Statt zu notieren, dass hier die Frist geprüft wird, benennst du die Funktion so. Kommentare veralten still, weil sie beim Ändern niemand mitzieht, Namen dagegen stehen mitten im Weg.
Wertvoll bleiben Kommentare, die das Warum festhalten. Wenn eine Berechnung von der offensichtlichen Formel abweicht, weil eine Abrechnungsregel es verlangt, oder ein Fremdsystem ein ungewöhnliches Datumsformat liefert, gehört genau das in den Code, denn diese Information steht nirgends sonst.
Wo die Regeln an ihre Grenzen stoßen
Die Regeln sind Werkzeuge, keine Gebote. Eine Funktion in drei Zeilen aufzuteilen, nur um unter einer Zeilengrenze zu bleiben, macht den Code nicht lesbarer, sondern verteilt ihn über so viele Stellen, dass niemand den Ablauf mehr am Stück sieht. Auch DRY kann zu weit gehen: Zwei Codestellen, die heute gleich aussehen, aber aus verschiedenen fachlichen Gründen existieren, entwickeln sich oft auseinander und gehören dann nicht in eine gemeinsame Funktion.
Einige Empfehlungen aus dem Buch sind unter Entwicklern umstritten, vor allem die sehr kurzen Funktionen und der weitgehende Verzicht auf Kommentare. Maßstab bleibt immer, ob jemand anderes den Ablauf beim ersten Lesen versteht. Wo eine Regel dem im Weg steht, hat sie in diesem Fall verloren.
KI-generiertDieses Bild wurde mit KI erzeugt · Yves Hoppe / KI / cmt
Clean Code und was oft damit gleichgesetzt wird
Entwurfsmuster sind Lösungsschablonen für wiederkehrende Entwurfsprobleme. Clean Code betrifft die Ebene darunter, also Benennung und Struktur im Kleinen, unabhängig davon, welches Muster du wählst.
Clean Architecture ist ein späteres Buch und Architekturmodell desselben Autors. Es ordnet ganze Anwendungen in Schichten, bei denen die Fachlogik nicht von Datenbank oder Oberfläche abhängt. Clean Code bleibt auf der Ebene einzelner Funktionen und Klassen.
Refactoring ist die Tätigkeit, die Struktur zu ändern, ohne das Verhalten anzutasten. Clean Code beschreibt den Zustand, den du damit anstrebst.
Technische Schuld ist die bewusst oder unbewusst aufgeschobene Aufräumarbeit samt ihrer Zinsen in Form langsamerer Änderungen. Unsauberer Code ist ihre häufigste Form.
KI-generiertDieses Bild wurde mit KI erzeugt · Yves Hoppe / KI / cmt
Ohne verbindliche Regeln entscheidet der Lauteste im Review
Diskussionen über Einrückung und Anführungszeichen gehören nicht in ein Review. Ein Formatierer, der beim Speichern läuft, und ein Linter mit einmal abgestimmten Regeln in der Pipeline nehmen diese Themen vollständig aus dem Gespräch, und danach reden alle über Fachlichkeit und Verständlichkeit statt über Leerzeichen.
Aufräumen ohne Tests ist ein Risiko. Bevor du eine gewachsene Funktion zerlegst, brauchst du eine Absicherung, die zeigt, dass das Verhalten gleich bleibt. Genau in dieser Reihenfolge, erst Testabdeckung, dann Umbau, wird aus Refactoring eine ruhige Arbeit statt einer Wette.
Im gewachsenen System scheitert der große Aufräumauftrag zuverlässig. Was funktioniert, ist die Boy-Scout-Rule als Teamvereinbarung: Jede Änderung lässt die berührte Datei ein Stück besser zurück. Das ist überprüfbar, passt in jedes Review und braucht kein eigenes Budget.
Clean Code lernen
Wo im eigenen Code die teuren Stellen liegen und wie du sie ohne Risiko entschärfst, arbeiten die Clean-Code-Trainings für Entwicklerteams an mitgebrachten Beispielen heraus.
Kurse, die Clean Code behandeln
- Clean Code Entwicklerschulung
- Clean Code Training für Java Entwickler
- Clean Code für .NET Entwickler
- Clean Code Training mit Python
Weitere Kurse aus diesem Bereich
- Code-Optimierung mit ChatGPT
- pytest Einführungskurs – Testgetriebene Entwicklung von Python-Code
- Android-Apps entwickeln mit Clean Architecture
- Codegenerierung für Classic AUTOSAR-Softwarekomponenten
- IREB® RE@Agile Kompakt - Primer und Practitioner
- IREB® Foundation Level 3.0 (CPRE)
- IREB® RE@Agile Practitioner (CPRE-AL)
- IREB® RE@Agile Primer (CPRE)
Häufige Fragen
Wer hat Clean Code erfunden?
Kostet sauberer Code nicht erst einmal mehr Zeit?
Gilt das auch für Skripte, die nur einmal laufen?
Lässt sich Clean Code messen?
Passt thematisch dazu
Als Vorsatz setzt sich davon nichts durch, im Alltag trägt es erst ein Review, das nach Stunden statt nach Tagen zurückkommt.
Welche Tests einen Umbau wirklich absichern, entscheidet die Gewichtung von Unit-, Integrations- und Oberflächentests.
Deine Ansprechpartner
Du willst das Thema nicht nur nachschlagen, sondern anwenden können? Wir beraten dich persönlich und kostenlos.
Yves Hoppe
Weiterbildung & Beratung
Ordnet mit dir ein, welcher Kurs zu deinem Vorwissen passt.
Norbert Jansen
Beratung & Inhouse
Plant Inhouse-Trainings, die an euren eigenen Daten und Abläufen ansetzen.
Clean Code im Kurs statt im Lexikon
Nachschlagen bringt dich bis zum Verstehen. Anwenden lernst du an echten Aufgaben.