Wie und wieviel kommentiert Ihr Euren Code

[himitsu]

Zitat von hoika:

Weil ich bei 100 Änderungen an einer Datei mit jedem CVS ewig brauche,
um den Entwickler und das Datum zu erfinden, der eine bestimmte Änderung verbrochen hat.

Die guteren CVS sagen dir aber wer welche Zeile zuletzt eingecheckt hat.
Bei SVN nennt sich das Blame (Schuld).



Hab extra das Wort "Besser" vermieden

[Jim Carrey]

Zitat:

{ Entwickler-Kürzel, Datum, Version }
{ argz, was soll denn das -2 ??? }
//for i:= 0 to StringList.Count-2
for i:= 0 to StringList.Count-1
{ Ende: Kürzel, Datum Version }

Was ist denn, wenn Entwickler 2 innerhalb der Schleife etwas abändert?
Er darf dann ja nicht als Entwickler der kompletten Schleife angegeben werden.

Das würde zu einer großen Unübersichtlichkeit führen meiner Meinung nach.

[Sailor]

Knuth hatte da mal in den 90igern was, nannte sich "Literate Programming" mit Hilfe von WEB. Die Idee war, einen Text zu schreiben, aus dem durch Übersetzung sowohl der Programmtext als auch die Dokumentation erzeugt wurden. Ich habe das mal versucht, aber dann entnervt aufgegeben. Allerdings könnte das heute mit modernen Editoren, Displays und schnellen Rechnern anders aussehen. Müßte man sich mal wieder ansehen.

[himitsu]

Zitat von Sailor:

Die Idee war, einen Text zu schreiben, aus dem durch Übersetzung sowohl der Programmtext als auch die Dokumentation erzeugt wurden.

Das nennt sich Shakespeare Programming Language

https://de.wikipedia.org/wiki/Shakes...mming_Language
https://de.wikipedia.org/wiki/Esoter...rammiersprache
https://de.wikipedia.org/wiki/Liste_...ammen/Sonstige

Die Pascal-Syntax an sich ist selber auch so entworfen, damit man dass schreibt, was man machen will.

[p80286]

Zitat von Jim Carrey:

Delphi-Quellcode:

{ Entwickler-Kürzel, Datum, Version }
{ argz, was soll denn das -2 ??? }
//for i:= 0 to StringList.Count-2
for i:= 0 to StringList.Count-1
{ Ende: Kürzel, Datum Version }

Was ist denn, wenn Entwickler 2 innerhalb der Schleife etwas abändert?
Er darf dann ja nicht als Entwickler der kompletten Schleife angegeben werden.

Das würde zu einer großen Unübersichtlichkeit führen meiner Meinung nach.

Im Prinzip halte ich das für sehr gut, nur die Umsetzung ist nicht so dolle.

Delphi-Quellcode:

//for i:= 0 to StringList.Count-2  { argz, was soll denn das -2 ??? } { Entwickler-Kürzel, Datum, Version }
for i:= 0 to StringList.Count-1

Ist meiner Meinung nach ausreichend. GGF. kann man auch die Vereinbarung treffen, das ersetzte Code Teile mit (* *) auskommentiert werden.

Gruß
K-H

[jaenicke]

Zitat von striderx:

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.

Zitat von himitsu:

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, ...

[hoika]

Hallo,
ich hatte ja gesagt, dass die auskommentierten Änderungen auch mal gelöscht werden.
Das mit dem Blame habe ich so nicht verstanden ...
Wir haben SVN, mal im RedBook lesen.

Trotzdem möchte ich durch Lesen des Quellcodes sofort wissen, wann wer für welche Version das eingebaut hat.
Und Version muss nicht mit der SVN-Branch ocer SVN-Tag übereinstimmen.

Aber das soll jeder ja so machen, wie er es gewohnt, versteht oder es gefordert wird.

http://svnbook.red-bean.com/de/1.7/s...n.c.blame.html
Nun ja, so gut ist das dann doch nicht (Stichwort Leerzeichen korrigiert).
Aber für sowas haben wir ja eh keine Zeit

[Rollo62]

Zitat:

ch hatte ja gesagt, dass die auskommentierten Änderungen auch mal gelöscht werden.

+1

Das finde ich während der Entwicklung, in dem jede Menge Tests gemacht werden völlig OK.
Gelöschte Tests wiederherzustellen ist viel problematischer als sie einfach wegzukommentieren.

Guter Stil hin, schlechter Stil her: Ich mache das was mich schneller zum Ziel bringt, auch wenn's nicht immer hübsch aussieht

Rollo

[striderx]

"Real programmers don’t document. If it was hard to write, it should be hard to understand."

"Documentation is like sex: when it is good, it is very, very good; and when it is bad, it is better than nothing."


Wie viele schöne andere Sprüche zu finden auf

https://henrikwarne.com/2016/04/17/m...amming-quotes/