Eure besten Quellcode Kommentare...

[MaBuSE]

Zitat von himitsu:

Es gibt in Firmen teilweise vorschriften, wonach x% des Quellcodes Kommentare sein müssen.
Da kommt dann auch oft sowas bei raus.

In Deiner Brust scheinen 2 Herzen zu schlagen

Einerseits schreibst Du, dass wenn Firmen den Entwicklern vorschreiben, sie möchten bitte dokumentieren (Quellcode, Handbücher, Readme, ...), oft nur Müll rauskommt.

Zitat von himitsu:

Manmal würde ich mir wünschen, wenn es überhaupt Kommentare oder wenigstens eine halbwegs verständliche Hilfe gäbe,
aber wenn man schon tagelang verzweifelt sucht und von einem Problem ins nächste stolpert,...

Andererseits möchtest Du in Quellcode Kommentare und "wenigstens eine halbwegs verständliche Hilfe" haben.

Zitat von MaBuSE:

Ich habe auch schon Projekte gesehen, die mehrere Mio Zeilen Quelltext lang sind und per Definition in ca. einer Stunde entstanden sein müssen.
Na ja, bei uns gibt es eine Arbeitsanweisung, dass ca. 10% der Zeit für Dokumentation einzuplanen ist.
Und der/die Entwickler haben sich nicht mal 10 Min Zeit genommen für Doku und Kommentare.

Bei uns gibt es die Richtlinie, dass in der Zeitschätzung ca. 10 % für Dokumentation vorzusehen sind.
Das beinhaltet Quellcode Kommentare, Readme Dateien, Installations-Anweisungen, Benutzerbücher, ...

Der Entwickler nutzt die 10% aber lieber als Puffer um seine Arbeit fristgerecht abzuschließen. Doku ist ja nicht wichtig.

[himitsu]

Das Beispiel aus #514, hatten wir hier öfters mal.

Grade in dem was man in einigen Schulen lernen soll, da war wirklich jede einzelne Zeile kommentiert, was da gemacht wird, auch wenn 95% davon der Quellcode selber gesagt hat nd weitere 4%, wenn man ordentliche Namen für Variablen/Funktionen benutzt hätte.
Nur die eine Zeile, die jemand nicht verstand, weil es dem Code nicht richtig anzusehn ist, was ermacht, das war Die ohne Kommentar.



Kommentare nur um des Kommentares Willen, ohne dass er einen Mehrwert bringt, außer den Code zwischen sich untergehen zu lassen ... nja