Guter Code

[freimatz]

Zitat:

...ist durch richtige Kommentierung auch nach 3..n Monaten noch verständlich.

Nein, benötigt keine Kommentierung. Wenn ein Code einer Kommentierung bedarf die erklärt was der Code macht ist der code schlecht.
Gut ist Kommentierung nur, wenn sie erklärt WARUM es gemacht wird.

Zitat:

Ich toleriere auch einen abweichenden Style anderer, und das sogar gern... einfach weil es gut ist, wenn man schon nach 2 Bildschirmseiten "sicher" erkennt wer das programmiert hat. Man weiß wenn was nicht(mehr) klappt an wen man sich wenden muss bzw. bei den "Ex...", an wen man sich nicht mehr direkt wenden kann.

Den Grund lasse ich nicht gelten, denn dafür gibt es Tools (Blame)

Das Wichtigste für mich ist immer noch:

Zitat:

Clean Code

Da ist eigentlich alles andere hier mit drin.

Und außerdem: Es freut mich shr dass du dich für guten Code interssierst. Das ist schon mal die Grundvoraussetzung.

[himitsu]

Zitat:

denn dafür gibt es Tools (Blame)

Wenn er das aber umformatiert und eincheckt, dann steht er selbst dort als "Schuldiger" drin.

[Delphi-Laie]

Zitat von freimatz:

Zitat:

...ist durch richtige Kommentierung auch nach 3..n Monaten noch verständlich.

Nein, benötigt keine Kommentierung. Wenn ein Code einer Kommentierung bedarf die erklärt was der Code macht ist der code schlecht.
Gut ist Kommentierung nur, wenn sie erklärt WARUM es gemacht wird.

Was der Code macht, muß man nie erklären, denn das sieht man ja selbst.

[himitsu]

Sag das mal den Lehrern.
i := i + 1; // Addiere 1 zur Variable i

Ich hatte hier in der DP einmal das beste Antipattern für Überkommentierung gesehn, da war wirklich jeder einzelne Befehl kommentiert.
(leider vergessen mir den Post zu merken )
Nachbauen kann ich diesen Antipattern leider nicht. Hatte ich schon versucht, aber so schön bekam ich das einfach nicht hin.

Das Ergebnis war, dass man den einzigen "wichtigen" Kommentar so garnicht bemerkte.

[Luckie]

Ich habe her http://michael-puff.de/Programmierun...leanCode.shtml die wichtigsten Punkte aus dem Buch Clean Code von Robert C. Martin zusammen getragen.

[p80286]

Also was die Kommentierung angeht, bin ich der Meinung, daß z.B. API-Aufrufe immer kommentiert gehören. Aber darüber kann man trefflich streiten.
Da ich mit dem IBM-BIOS aufgewachsen bin, kommentiere ich u.U. etwas zu viel.

Gruß
K-H

[himitsu]

Ein paar Beispiele für nicht immer sehr gute Kommentare und Codes.
http://www.delphipraxis.net/96226-eu...ommentare.html

@Herr Puff, sie wurden schon 5 Kommentare vorher verpetzt.

[Luckie]

Zitat von himitsu:

@Herr Puff, sie wurden schon 5 Kommentare vorher verpetzt.

Wenn ich den erwische!

[PascalDeveloper]

Vielen Dank für die Antworten ich habe mir Jetzt das Buch Clean code von Robert C. gekauft welches sehr ausführlich und informativ ist.

[PascalDeveloper]

Vielen Dank für die Antworten ich habe mir jetzt das Buch Clean code von Robert C. gekauft welches sehr gut ist und ich nur weiterempfehlen kann