Besser gar keine Kommentare als falsche oder sinnlose ala
Delphi-Quellcode:
// *******************
// * Prozdur bla *
// *******************
procedure bla;
var
i: integer; // Schleifenvariable
begin
// alle Listenelemente durchlaufen
for i := 0 to Liste.Count -1 do begin
// Listenelement verarbeiten
Process(Liste[i]);
end;
end;
Leider gibt es immer wieder Firmen die genau sowas wollen. Ich war mal in einer Firma, da sah der Quellcode genauso aus, weil der Entwicklungsleiter darauf bestanden hat, dass jede einzelne Zeile Code kommentiert werden muss. Da kommt dann so ein Müll bei raus. Manchmal habe ich fürs Kommentieren länger gebraucht als für das Schreiben der Funktion.
Dann hätte ich das so gemacht
Delphi-Quellcode:
// *******************
// * Prozdur blub *
// *******************
procedure bla;
var
i: integer; // j
begin
// for j := 0 to MeineListe.Count -1 do begin
for j := 0 to MeineListe.Count -1 do begin
// Process(MeineListe[j]);
Process(Liste[i]);
end;
end;
da wäre die Verwirrung perfekt
oder besser so:
Delphi-Quellcode:
//
procedure bla;
var
i: integer; //
begin
//
for i := 0 to Liste.Count -1 do begin
//
Process(Liste[i]);
end;
end;
Dann ausdrucken und offline kommentieren.