Richard schrieb am 6. Dezember 2011 17:47
[...]
Und am anderen Ende des Spektrums dann natürlich auch jede Menge
unsägliches Gewurstel, das - streng nach Richtlinie - hervorragend
"dokumentiert" ist. Nur hilft so bei so einem Quark wie
int foo = frobnicate(bar); // foo is now frobnicated by bar
die "Dokumentation" halt auch nicht viel weiter :-/
Das da oben ist streng nach Richtlinie hervorragend dokumentiert?
LOL! Die Richtlinie ist Banane! Man dokumentiert nicht was man gerade macht, sondern warum.
Das hier ist ein totaler Schwachsinn!
// We run a loop from 0 to 9 and then ....
for (counter = 0; counter < 10; counter++) blablabla;
Diese Art von Dokumentation ist unbrauchbar. Jeder der nur halbwegs Code lesen kann, sieht das hier von 0 auf 9 gezählt wird usw. Das ist keine Dokumentation. N00bs und rookies dokumentieren so. Besser wäre es gewesen überhaupt nicht diesen Kommentar da rein zu schreiben und irgend wo später bessere Dokumentation rein zu tun in den Code als
den Code mit diesem Müll zu versauen.