Quellcode Kommentieren

[sx2008]

Also bei uns in der Abteilung war das auch mal schwer in Mode *grundsätzlich* vor jede Funktion/Procedure/Methode einen Kommentarblock zu setzen.
Aber wenn man mal darüber nachdenkt, kommt man drauf dass das eigentlich ziemlich dumm ist.
Denn meistens steht im Kommentar nicht mehr als in der Funktion selber.
Wann eine Funktion erstellt und geändert wurde ist relativ uninteressant werden man eine Versionsverwaltung verwendet.
Und wenn man keine Versionsverwaltung hat dann wird's aber höchste Eisenbahn.

Die Nachteile der Zwangskommentare sind:
* Zeitverschwendung durch Einfügen und Pflegen von Kommentaren die keinen Zusatznutzen bringen
* visuelles Störfeuer - je mehr Zeichen auf dem Bildschirm sind umso mehr Kapazität benötigt das menschliche Gehirn um Wichtiges von Unwichtigem zu trennen
* die Stellen die wirklich mal einen Kommentar haben fallen gar nicht auf weil überall Kommentare stehen
* anstatt darüber nachzudenken wie man die Funktionen sprechender machen könnte verlässt man sich auf nutzlose Kommentare die im Zweifelsfall doch eh falsch sind weil sich Funktionsname und/oder Parameter geändert haben

Meine Empfehlung:
vor wichtigen/komplizierten/erklärungsbedüftigen Funktionen schreibt man eine Kommentarezeile die kurz beschreibt was die Funktion macht.
Hier ein Beispiel:

Delphi-Quellcode:

// wandelt einen Speicherbereich in einen hexadezimalen String
function BufferToHexString(buffer:Pointer;size:Integer):AnsiString;
begin
   if not Assigned(buffer) or (size<=0) then
      Result := ''
   else
   begin
      SetLength(Result, size*2);
      BinToHex(PChar(buffer), PChar(Result), size);
   end;
end;

Wobei in obigem Beispiel der Funktionsname schon so sprechend ist dass man auf den Kommentar auch verzichten könnte.
Mehr als eine Zeile zu schreiben ist nicht verboten!