Einzelnen Beitrag anzeigen

Benutzerbild von jaenicke
jaenicke

Registriert seit: 10. Jun 2003
Ort: Berlin
9.344 Beiträge
 
Delphi 11 Alexandria
 
#36

AW: Wie und wieviel kommentiert Ihr Euren Code

  Alt 5. Okt 2016, 20:54
Von der IT eines großen Konzerns kenne ich Programmiervorgaben, die einen bestimmten Anteil von Kommentierungen einfordern (z. B. 20 Prozent des Quellcodes).

Der Hintergrund dafür: Geschäftskritische Anwendungen müssen auch wartbar sein, nachdem die ursprünglichen Entwickler nicht mehr zur Berfügung stehen.
Dafür sind solche Vorgaben oft genau nicht geeignet. Ich habe schon solche Projekte gesehen. Da wurde dann um die Quote zu erfüllen extra kommentiert, dass eine Schleife für jeden Eintrag einmal durchlaufen wird usw., dafür wurden Variablennamen oft nur mit einem Zeichen geschrieben. Denn die Erklärung steht ja im Kommentar.
Das macht den Quelltext dann deutlich schlechter lesbar und extrem schlecht zu warten.

Deshalb stammen solche Vorgaben oft aus dem Management und nicht von denjenigen, die damit arbeiten. Um es mal vorsichtig auszudrücken.

Viel wichtiger als Kommentare oder Dokumentationen der einzelnen Routinen ist erst einmal eine Gesamtdokumentation, in der drin steht wie das ganze Projekt organisiert ist, wie die Abläufe grundsätzlich sind (Pattern, Dateiorganisation, ...), usw.

Denn wenn der Quelltext sauber geschrieben wurde, lese ich den Code eher schneller als jede Dokumentation. Wenn ich aber keinen Grundfahrplan habe wie das Projekt aufgebaut ist, finde ich mich erst einmal schlecht in das Projekt hinein. Und das kostet dann wirklich sehr viel Zeit.

Die guteren CVS sagen dir aber wer welche Zeile zuletzt eingecheckt hat.
Bei SVN nennt sich das Blame (Schuld).
Und man kann dann auch von dort aus die vorherige Änderung der Zeile suchen usw., egal ob bei Git, Mercurial, SVN, ...
Sebastian Jänicke
Alle eigenen Projekte sind eingestellt, ebenso meine Homepage, Downloadlinks usw. im Forum bleiben aktiv!
  Mit Zitat antworten Zitat