Da es in einem meiner letzten Projekte vorkam und sich jetzt auch öfter wiederholt hat, möchte ich einmal dazu etwas schreiben. Das Thema ist „Programmieren“.
Beim Programmieren in einer der meisten gängigen Programmier- oder Scriptsprachen schreibt man Quellcode. Dieser Quellcode ruft oftmals Prozeduren oder Funktionen auf, die mit den Bibliotheken beim Compiler mitkommen. Der Programmierer schreibt aber auch eigene. Dabei geht es mir um diese Themen:
- Verzeichnis- und Dateihierarchie
- Benamung von Dateien
- Benamung von Codebestandteilen
- Funktionen
- Prozeduren
- Klassen/Interfaces
- Variablen
- Konstanten
Mir ist oft aufgefallen, dass diesen Themen oftmals nur ungenügend Aufmerksamkeit geschenkt wird, dabei ist das, meiner Meinung nach, unglaublich wichtig, wenn
- Der Code gewartet werden soll über Jahre oder Dekaden
- Andere den Code verstehen sollen
- Andere den Code ändern oder erweitern sollen
- Andere den Code portieren sollen
- Es keine ausreichende Dokumentation gibt
Ein Beispiel. Wir haben eine Funktion, die sieht selbst so aus und hat folgenden Inhalt:
int ab_ad_nmb_re(int pab, int p_ab, bool ab) {
int pab_list;
char *pa;
…
}
Da gibt es mehrere Probleme:
- Der Funktionsname besteht aus etlichen Abkürzungen, die ein anderer nicht kennt, nachschlagen und sich merken muss. Oder immer wieder nachschlagen muss. Dementsprechend nichtssagend ist der Name
- Die Variablen heißen alle fast gleich, sind nichtssagend und unglaublich verwirrend
Oftmals, von mehreren unterschiedlichen Leuten, höre ich dann folgende Argumente:
- Ich weiß ja, was das alles heißt
- Du kommst da schon irgendwann rein
- Wir können doch keine aussagekräftigen Namen nehmen, da das dann zu lang ist und dann bringt das auch keinem was
Ehrlicherweise muss ich da sagen: Nein. Ich nehme (s. GitHub) halbwegs aussagekräftige Namen (manchmal, selten, auch mal nicht, das sollte so aber nicht sein). Sie sagen aus, was sie machen, man braucht keine oder wenig Dokumentation und auch andere sind schnell eingearbeitet und können Änderungen vornehmen.
Bezüglich langer Namen: Jeder halbwegs taugliche Editor zum Programmieren bietet Autovervollständigung. Selbst VIM bringt im Standard bereits eine kontextlose Autovervollständigung mit, die ich gerne benutze: [Strg]+[p/n]. Damit sind längere Namen kein Problem mehr, da nur der oder ein paar Anfangsbuchstaben getippt werden müssen.
Das hat viele Vorteile:
- Der Code wird lesbarer
- Andere können sich viel schneller einarbeiten
- Der Code selbst ist Dokumentation
Mein altes Projekte Warehouse nutzt solche Namen an den meisten Stellen. Das Projekt ist von 2009 und wurde mit VIM umgesetzt. Aber schaut euch auch Frameworks an, die Methodennamen mit vernünftiger Benamung haben wie Qt, wxWidgets, Java-SDK, uvm.
Ich kann nur empfehlen, lieber den Code etwas aussagekräftiger zu gestalten, denn meiner Meinung nach zahlt sich das schnell aus. Speicher ist günstig, da machen die paar Bytes den Kohl auch nicht fett.
