Kommentieren...

Über Kommentierung von SourceCode kann man ja trefflich streiten. Ich persönlich bin der Meinung dass es sinnvolle Kommentare gibt (da weiche ich schon zu den Hardlinern ab, die der Meinung sind Code ist Code ist Selbsterklärend). Kommentare sollten dann platziert werden, wenn beim Implementieren etwas Hirnschmalz gefordert war - oder wenn die Gefahr hoch ist, dass man es in ein einem halben Jahr vergessen hat um was es im einzelnen ging. 

Beispiel: Annahmen oder Voraussetzungen: ein Algorithmus der voraussetzt, dass eine Liste aus einem DB ResultSet bereits sortiert und gefiltert vorliegt - was ggf durch ein DB Statement schon passiert, ist durchaus einen Kommentar wert. 

Getter und Setter *seufz* müssen nicht kommentiert werden.

Hier mal ein Real World Beispiele

// write HistorieLauf
writeHistorieLauf();

oder
// init Batchlauf record
initBatchlauf();

oder


commit(); // commit work



Sind jetzt nicht gerade Kommentare die das Verständnis fördern.


Mein persönlicher Favorit:

// Hallo Co-Entwickler! Dieser
// Code mag umständlich sein,
// dient aber mir zum fachlichen
// Verständnis! Bitte so
// lassen...