Quellcode Kommentieren

[Bernhard Geyer]

Zitat von Sherlock:

Doku der Doku wegen ist ne brisante Frage. Da muss man sich mit einem TÜV-ler oder echten Qualitätsmanager drüber unterhalten. Am Ende macht es Sinn, aber es ist verdammt schwer sich dran zu halten.

So wie tausende Seiten Pflichten/Lastenheft die jeden sch*** bis zum letzten Pixel beschreiben obwohl im länger dauernden Projekt (und das auch jeden klar ist) 95% dieser Dokumentation hinfällig wird.

[Hansa]

Dejan Vu hat Recht. Der beste Kommentar ist selbsterklärender Quelltext. Dann sind nämlich die Kommentare direkt "impementiert". Bei folgender Zeile einen solchen Kommentar zu schreiben ist völliger Schwachsinn :

procedure test; // das ist die Prozedur Test Hier allerdings (Pseudocode) :

Mwst := Mwst * 1.19; // Achtung : MWST. zu Testzwecken in EXE eincompiliert !! Muss noch geändert werden! 10.XXX Das wäre schon wichtig. Wobei das 10.XXX für Version steht. Dient halt zum Suchen im Source. Kann natürlich nach Belieben verfeinert werden. Und es gibt für solche Fälle direkt in Delphi ja auch noch ToDo.

[Nersgatt]

Zitat von Hansa:

Mwst := Mwst * 1.19; // Achtung : MWST. zu Testzwecken in EXE eincompiliert !! Muss noch geändert werden! 10.XXX

Da würde sich IMO eine Warnung eher anbieten:
{$message Warn 'Achtung : MWST. zu Testzwecken in EXE eincompiliert !! Muss noch geändert werden!'} Dann fällt es einem wenigsten bei jedem Erzeugen auf die Füße. Sofern das Fenster nicht sowieso mit Warnungen überquillt...

Im übrigens bin ich ganz der Meinung von dejan vu.