Kommentare, die die Welt nicht braucht – XVI
Tuesday, February 2nd, 2010Bullshit? Vermutlich.
Bullshit? Vermutlich.
Heute ein Nils-D.-Gedächtnis-Eintrag:
DAS nenne ich mal einen selbsterklärenden Funktionsnamen!
Gefunden von Sven:
if($res == “o” && !logged_in() && !logged_in() && !logged_in())
Redundanter Code ist zu vermeiden Apropos “if”:
Umso selbsterklärender Funktions- und Variablen-Namen sind, umso weniger Kommentare braucht es. Und umso nötiger scheint diese Kolumne
Sauber aufgebaute Photoshopdateien zeichnen sich durch sinnvoll gruppierte und benannte Ebenen aus.
Einsicht ist der erste Weg zur Besserung!
Wirklich kreative Nerds übertragen das Konzept des Kommentars auf alle Bereiche ihres digitalen Lebens… zum Beispiel auf die Ordnerstruktur ihres Betriebssystems. Durchaus lobenswert – da kann man über mangelnde Höflichkeit in der Formulierung hinwegsehen
Es ist nicht immer einfach, die Folgen von Änderungen an anderer Leute Code vorherzusehen. Kommentare helfen – insbesondere, wenn es sich um solch schwerwiegende Konsequenzen handelt.
Verklärte, ja intime Gefühle des Webentwicklers für seinen Code zeugen von Freude an der Arbeit – und äußern sich in Kosenamen für zum Beispiel HTML-Formulare.
Dank an Moritz!
Aussagekräftige Funktionsnamen erhöhen das Verständnis des Codes – Kommentare sind dann häufig gar nicht nötig.
Heute wieder Beispiele für gute, ja ausgezeichnete Quellcode-Kommentare:
Die Angabe eines Autors ermöglicht es, Code(-änderungen) einer Person zuzuordnen – was die Wartbarkeit erhöht:
Hin und wieder probiert man etwas aus, dass dann aber nicht den erhofften Erfolg bringt. Aussagekräftig (aus-)kommentiert erspart man seinem Nachfolger, in dieselbe Falle zu tappen:
Programmierer sind Menschen! Man sollte sie ihre Freude ausdrücken [...]
Und weil es so schön war – selbsterklärende Variablennamen gehören zum guten Stil!
PS: Nupsi bei Wikipedia