@alphaflight83: dein Kommentarstil ist na ja, etwas "ineffizient".
Hier zwei Beispiele:
Delphi-Quellcode:
(* Lock the canvas *)
Canvas.Lock;
(* Flush all the stuff to the canvas *)
Graphics.Flush();
Diese Kommentare haben keine Aussagekraft und sind damit mehr schädlich als nützlich.
Soll heisen, man sollte keine Dinge kommentieren, die ganz offensichtlich aus dem Code hervorgehen.
Stattdessen würde ein mehrzeiliger Kommentar vor der Methode der in zwei Sätzen erklärt,
was hier passieren soll deutlich mehr Information an den Leser geben.
Ausserdem brauchst du für jede Kommentarzeile zu viel Schreibaufwand, weil du (* *) anstelle von // benützt.
Ich benütze Kommentare so:
Delphi-Quellcode:
// das ist ein Einzeiliger Kommentar
{
mehrzeile Kommentare
lassen sich gut mit geschweiften Klammern umsetzen.
diese Blöcke setze ich gerne vor Methoden um zu erklären
was der folgende Code tun soll
}
(* auskommentierter Code
if debug_flag then
ShowMessageFmt('Anzahl=%d', [anz]);
*)
Styleguide > Kommentare
Und jetzt hätte ich noch eine Bitte an Alle:
bitte hier keine Diskussion über Kommentare im Sourcecode anfangen.