Der schnelle Weg zum besseren Code
Heute widme ich mich einem meiner Lieblingsthemen in der Clean-Code-Welt: Formatierungsregeln. Warum? Weil es sich um einen echten "Quick Win" handelt – eine Maßnahme, die sich in kürzester Zeit umsetzen lässt und sofort erkennbare Vorteile für das gesamte Projekt bringt.
Einfach – zumindest technisch
Lange Zeit dachte ich, dieser Punkt sei der einfachste auf der Clean-Code-Liste: Das Team einigt sich auf Formatierungsregeln, speichert diese in einer Konfigurationsdatei und stellt sie allen Entwicklern zur Verfügung. Jeder importiert sie in seine IDE und schon ist das Problem gelöst. Technisch ist das tatsächlich unkompliziert und bringt unmittelbar zahlreiche Vorteile.
Die menschliche Komponente
Allerdings enthält dieser Plan einen kritischen Satz: "Das Team einigt sich" – und genau hier liegt oft die Herausforderung, nicht nur in IT-Projekten. Jeder von uns hat eigene Präferenzen, Meinungen und einen individuellen Stil. Ich persönlich bevorzuge beispielsweise eine maximale Zeilenlänge von etwa 100 Zeichen (80 funktioniert auch hervorragend, besonders bei kleinen, fokussierten Funktionen). Diese Präferenz lässt sich gut begründen: Menschen lesen Text am effizientesten in schmalen Spalten von oben nach unten, nicht von links nach rechts – ähnlich wie bei Zeitungen ("The Newspaper Metaphor"). Ein zusätzlicher Vorteil zeigt sich bei Code-Vergleichen in GitLab oder anderen Tools während Code Reviews.
Persönliche Präferenzen vs. Teamstandards
Bei Fluent APIs finde ich es zudem sinnvoll, jeden Methodenaufruf in eine neue Zeile zu schreiben (aus dem zuvor genannten Grund). Doch wichtiger als jede persönliche Meinung ist die Einheitlichkeit der Quelltexte im Projekt. Warum? Weil wir keine wertvolle Zeit für manuelle Code-Formatierung verschwenden sollten. Dafür haben wir moderne IDEs mit Automatisierungsfunktionen – und Automatisierung ist einer der Schlüsselfaktoren für erfolgreiche IT-Projekte.
Die konkreten Vorteile
Einheitlich formatierter Code bietet entscheidende Vorteile:
Code Reviews werden effizienter, da man sich auf fachliche Änderungen konzentrieren kann
Wesentliche Aspekte der Implementierung sind leichter erkennbar
Entwickler sparen mentale Energie, die sie stattdessen für Weiterbildung oder Innovation nutzen können
Praktische Vorgehensweise
Wenn ich ein neues Projekt bei einem Kunden beginne, importiere ich als Erstes die Formatierungsregeln. Meist arbeite ich mit IntelliJ, das problemlos Konfigurationen aus VS Code, Eclipse und anderen IDEs importieren kann. Nach einiger Zeit im Projekt teile ich Empfehlungen und Verbesserungsvorschläge mit dem Team, wobei ich ihnen die Entscheidungsfreiheit lasse – ein Ansatz, der sich bewährt hat.
Clean-Code-Empfehlungen zur Formatierung
Im Clean-Code-Kontext gibt es zahlreiche detaillierte Empfehlungen zur vertikalen und horizontalen Formatierung, die sich am besten durch Beispiele veranschaulichen lassen – wofür hier leider der Platz fehlt.
Der wichtigste Tipp
Meine heutige Empfehlung lautet: Einigt euch als Team auf Standards und wendet sie konsequent an. Parallel könnt ihr euch mit Clean-Code-Prinzipien vertraut machen und prüfen, welche für euer Team am besten passen. Das Allerwichtigste jedoch: Verschwendet keine Zeit mit manueller Code-Formatierung! Trinkt stattdessen lieber einen Kaffee mit euren Kollegen und diskutiert über wirklich spannende fachliche Herausforderungen.
