nicht angemeldet
Moin!
Früher hat man gelernt, möglichst 1/3 Kommentare zu schreiben, aber in der Wirtschaft gibt es fast nur Kommentare, wenn es Außergewöhnliche Situationen im Code gibt. Bzw schwerer Verständliche Aktionen
Das liegt daran, dass man gemerkt hat, dass die 1/3-Regel einfach der Sache nicht angemessen ist. Es geht nicht darum, irgendeine Mindestquote an Kommentartext in den Source zu schreiben, sondern darum, dass der Sourcecode verständlich ist.
Das erreicht man nicht, indem man jeden Befehl, der für sich genommen schon eindeutig und klar ist, durch einen Kommentar ergänzt, der beschreibt, was dieser Befehl gerade macht:
$i++; // i erhöhen
Es geht vielmehr darum, dass an den Stellen, die durch den Programmcode nicht offensichtlich klar machen, was da getan wird, durch Kommentare eine Erklärung hinzugefügt wird.
Wobei das ein zweischneidiges Schwert ist: Kommentare veralten sehr schnell, wenn sich der Code weiterentwickelt, denn es ist für den Programmablauf egal, ob der Kommentar noch zum Code passt, oder nicht. Kommentare werden dann gepflegt, wenn der Programmierer von dieser Pflege irgendeinen Vorteil hat. Beispielsweise, weil seine IDE ihm bei der Code-Completion den PHPDoc-Block einblendet, der zu der angefragten Funktion bzw. Methode gehört.
- Sven Rautenberg
Der Martin
Struppi