Eine korrekte Codeformatierung ist nicht nur eine ästhetische Frage, sondern hat auch einen realen Einfluss auf die Wartbarkeit des Codes und die Effizienz der Programmierer.
Hier sind einige wichtige Praktiken für die richtige Codeformatierung.

1. Konsistente Einrückung:
Stelle sicher, dass eure Einrückung konsistent und logisch ist. Die Verwendung der gleichen Anzahl von Leerzeichen oder Tabulatoren für die Einrückung von Zeilen und Codeblöcken erleichtert das Lesen und Verstehen vom Code. Für alle Mitglieder, die den Code entwickeln oder nur zum Lesen öffnen, muss dieselbe Einrückung festgelegt werden.

2. Vertikale Ausrichtung:
Bei Codeblöcken mit mehrzeiligen Zuweisungen oder Funktionsaufrufen mit mehreren Argumenten müssen die entsprechenden Teile des Codes vertikal ausgerichtet werden, um die Identifizierung zusammengehöriger Teile zu erleichtern.

3. Begrenzung der Zeilenbreite:
Eine Codezeile sollte nicht die übliche Breite des Bildschirms überschreiten. Dadurch wird verhindert, dass der Code beim Lesen horizontal gescrollt werden muss. Wenn eine Codezeile zu lang ist, teilen Sie sie in mehrere Zeilen auf.

4. Hinzufügen leerer Zeilen:
Der Code muss ausreichend leere Zeilen enthalten, die kurze logische Codeblöcke voneinander trennen. Leerzeilen sollten, wie ein Punkt am Ende eines Satzes, einen Gedanken abschliessen.

5. Kommentare als Navigationshilfen:
Gut platzierte Kommentare können als Navigationshilfen dienen, die die Orientierung und das Verständnis im Code beschleunigen. Insbesondere am Anfang eines Codeblocks ist es ratsam, einen kurzen Kommentar einzufügen, der kurz und prägnant den Zweck oder die Funktion des nachfolgenden Codes beschreibt.