Kommentare, die die Welt nicht braucht – Folge 8

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:

comment_author_wayne

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:

comment_bringt_n_scheiss

Programmierer sind Menschen! Man sollte sie ihre Freude ausdrücken lassen!*
*an der Ausdrucksweise darf aber noch gearbeitet werden.

comment_fucking_easy

Kommentare sollten verständlich sein, auch ohne sich (wie der ursprüngliche Autor) 3 Tage in den Code zu denken. Formulierungen abseits von Fachchinesisch helfen dabei:

comment_roundhousekick

🙂 Frohe Ostern.

Leave a Reply

Your email address will not be published. Required fields are marked *

Ich erkläre mich damit einverstanden, dass alle eingegebenen Daten und meine IP-Adresse zum Zweck der Spamvermeidung durch das Programm Akismet in den USA überprüft und gespeichert werden. Weitere Informationen zu Akismet und Widerrufsmöglichkeiten.