| Zitat |
Original von Noodles
| Zitat | Original von Nostalb
2. Kommentare
Glaube ist nicht zu viel verlangt schwer verständliche stellen mit einem kommentar zu versehen. |
Guter Code ist selbstbeschreibend.
Die besten Kommentare sind dann solcher Art.
// wenn i 0 ist, dann i auf 1 setzen
if (i == 0)
i = 1;
|
Das ist schon klar. Guter Code sollte sich selber erklären eine der regeln für guten Code doch wie oft passiert es das man einen code zuammen hackt und man versteht ihn nach drei wochen selber nicht mehr. Das man nicht alles kommentiere sollte ist klar
aber ich denke da an wirklick unüberschaubaren code und wenn man schon zu faul ist ihn besser zu coden sollte man wenigsten einen kommentar schreiben.
Natürlich meinte ich auch nicht so ein beispiel wie du es geschrieben hast sondern eher soetwas:
function GetHits(startln, endln: Integer; lsLns: TList): Integer;
var
i: Integer;
begin
Result := 0;
for i := 0 to lsLns.Count - 1 do
begin
if (PProfRec(lsLns.Items[i])^.LineNo ≥ startln) and (PProfRec(lsLns.Items[i])^.LineNo ≤ endln) then
Result := Result + PProfRec(lsLns.Items[i])^.HitCount;
end;
end;
Jetzt meine Frage was macht die Funktion? (naja noch relativ leicht zu beantworten)
Doch welche werte enthält die Liste lsLns?
OK klar wenn man den ganzen code durchgeht wird das auch klar aber hätte ich folgenden kommentar geschrieben:
// Count the number of line hits between the lines startln and endln.
// lsLns is the List of PProfRecs that stores the Profile information
bräuchte man den code nicht zu durchforsten
Ahja und zum thema Englisch:
Wir schreiben sehr wohl Referate in englisch. Erst vor kurzem musste ich einen über australien schreiben der rund 15 seiten enthielt. Von daher setze ich mal vorraus das man auch praktisch mit englisch umgehen kann und nicht nur theoretisch.
cya
