In der Regel wird Programmcode einmal geschrieben, aber um ein Vielfaches häufiger gelesen. Jeder Programmierer entwickelt kontinuierlich seinen Schreibstil. Code, der vor einem Jahr geschrieben wurde, wirkt häufig fremd. Eben schnell den Bug finden ähnelt häufig dem Ablauf eines Sherlock-Holmes-Krimis. Spuren muss in größter Konsequenz nachgegangen werden und am Ende war es dann doch der Gärtner. Programmieren ist heute über dies hinaus zu einer Teamaufgabe geworden. Die Herausforderung ist also den Code so verständlich zu gestalten, dass auch Kollegen schnell verstehen können, was dieser eigentlich tut.
Eine lückenlose Dokumentation kann helfen, muss aber regelmäßig aktualisiert und angepasst werden. Einfacher können schon fixe Namenskonventionen immens zum Programmverständnis beitragen.
“There are only two hard things in Computer Science: cache invalidation and naming things.”
Phil Karlton
Diese Konventionen können je nach persönlicher Präferenz umgesetzt werden und entsprechen daher lediglich einer Empfehlung. Am Ende ist nämlich weniger die Wahl der Konvention entscheidend, sondern primär die Konsequenz.
Bewährt hat sich, dass der Variabelname die Funktion der variabel beschreiben und einem einheitlichen Thema folgen sollte. Setzt sich der Name aus mehreren Wörtern zusammen, müssen aber grundsätzlich Leerzeichen vermieden werden, da diese die Interpretierbarkeit beeinträchtigen. Mit Begrenzungsmethoden kann trotzdem die Lesbarkeit in Mehrwortkonstellationen gewährt werden.
Neben der Benennung von Variablen, Funktionen und Klassen sollte einheitliches Naming auch auf Dateien und Ordnerstrukturen angewandt werden, um damit die Orientierung im Projekt zu erhöhen.
Verständlichkeit = Einfachheit, Gliederung/Ordnung, Kürze/Prägnanz
Hält sich ein Team konsequent an fixe Regeln, wird die Codebasis und Projektstruktur deutlich einheitlicher und dadurch automatisch verständlicher.
Verständlichkeit steigert letztendlich die Produktivität.