Stimme auch hier mit Luckie überein. Ausserdem sind Kommentare so etwas ganz spezielles. Ich persönlich vermeide sie wenn möglich. Es gibt nichts schlimmeres als falsche oder "outdated" Kommentare. Darüber hinaus sind sie, bei korrekter Benennung der Funktion und Parameter einfach überflüssig. Statt "Mache ein foo für alle bar in der Liste" steht halt einfach "Mache ein foo für alle bar in der Liste" in der Syntax der Sprache da
. Von daher sehe ich die Notwendigkeit zu kommentieren als erstes Anzeichen für schlecht verständlichen und somit in den meisten Fällen auch wartbaren Code an. Wobei ich natürlich auch komplexere Konstrukte, die auf den ersten Blick evtl. nicht direkt zu durchschauen sind, mit einem entsprechenden Kommentar versehe, wenn sich die Komplexität anders nicht vermeiden lässt. Ausserdem wird Code, den ich für Leute in Boards schreibe, meist exzessiv kommentiert, weil ich keine Ahnung hab was die Leute können
.
Zitat von
R2009:
Jetzt im ernst:
Keine Zeile Kommentar im Quellcode ist zuviel!
Doch diese besagten Kommentare "Diese Funktion bekommt einen Char Pointer übergeben." sind einfach nur überflüssig.
Zitat von
R2009:
Aussagekräftige Prozedurnamen sind was schönes aber wer von uns neigt nicht dazu aus: zwei_Zeichen_in_string_einfuegen zw_zei_str zu machen und das ist dann nicht mehr lesbar.
Ich neige nicht dazu. Und jeder der in unserem Team dazu neigt, neigt nicht lange dazu oder darf sich auf dem Arbeitsmarkt andere Herausforderungen suchen
. Ansonsten gehört eine Doku natürlich dazu. Darüber brauchen wir uns ja nicht zu unterhalten.