Leitlinie beim Kommentieren

Programme müssen eine Geschichte erzählen

(ist eine vor Jahren mal gelesenene Weisheit)

Das meint:
Die Kommentare in einem Programm enthalten "die Prosa", damit alles zusammen (Code mit den jeweiligen Kommentaren) die "Geschichte" ergibt.
Denn die Programme müssen die Geschichte freiwillig erzählen, man soll ihnen den Sinn nicht mühsam abringen müssen (wie beim z.B. Marx'chen Kapital o.ä. Werken).

Für mich ist eine Methode: Was brauche ich für Infos, damit ich auch nach drei Monaten Urlaub das Programm/den Code-Abschnitt immer noch verstehe.

Man muss ein Prgramm nicht leicht und flüssig lesen könne wie z.B. gewisse Boulevard-Blätter. Aber den Sinn müssen sie "freiwillig" offenbaren!
Wir drucken z.B. unseren Programm-Code (wenn überhaupt) mit Schriftgröße 6 Punkt (Schriftart Courier New). Das kann man nicht leicht lesen, aber man soll es leicht verstehen können.

Ein Beispiel:

 /* Sinn */                         /* Unsinn */
lohn=lohn*1.05; /* 5% Tarif Erh. */     a=a*1.05;     /* a mal 1,05 */