Hey!

Ich hätte gerne mal eine Umfassende Sammlung von Argumenten Pro (und Contra?) zum Thema "Warum soll ich meinen Quellcode schon während der Entwicklung kommentieren?"

Geläufige Ausreden, die ich immer wieder höre, sind z.B.:
- der Code ist doch selbsterklärend
- der ist doch kommentiert...:


- what was hard to write should be hard to understand
- was weis ich denn was der [irgendwoher wil zusammenkopierte] Code macht?

Grüße, pktm

kommentiert codeblöcke erleichtern die navigation. wenn ich später was dranflansche, das ich weiss in welchen block das kommt damit ich alles wiederfinde.

gute namen für var und sub ist ja auch ne art kommentierung und macht vieles überflüssig ja, aber trotzdem ich kommentiere eigentlich gerne. nicht zu viel aber auch zur erinnerung wo etwas noch fehlt oder wozu man etwas geschrieben hat oder ab wo welcher teil der API anfängt da ich manche module habe wo subs in gruppen sind die eine API zu verschiedenen teilen bilden.

Mir wurde mal der wertvolle (und das meine ich ernst) Rat gegeben, nicht zu kommentieren, was der Code macht, sondern warum er etwas macht. Also zu welchem Zweck, was er mit der Eingabe macht usw.

ja sagt damian auch, find ich oft auch sinnvoll.

Für mich gibt es mehrere Arten von Kommentaren.
Den "strukturellen Kommentar":
Der ist für mich sehr wichtig, da ich mich leicht in meinem eigenen Code verirre und ich nicht mehr weiß, wo ich was stehen habe.

Den "beschreibenden Kommentar" in dem ich erkläre, warum ich etwas mache.
Der ist sinnvoll, da man leicht vergisst warum man etwas auf eine bestimmte Weise macht. Und Später ist es leichter den Code zu ändern, wenn einem eine bessere Methode einfällt.

Und natürlich die Schnittstellenbeschreibung (mit pod), in dem ich erkläre was die Funktionen machen. Schreibe ich meist zusammen mit den Funktions- und Klassenrümpfen, damit ich später selber noch weiß was in der Funktion stehen muss und das sie zurück liefert. meist Rahmen ich die pod Doku mit einem strukturellen Kommentar ein, damit ich beim programmieren nicht darüber stolper

pktm+2008-04-21 22:46:55--

Ich hätte gerne mal eine Umfassende Sammlung von Argumenten Pro (und Contra?) zum Thema "Warum soll ich meinen Quellcode schon während der Entwicklung kommentieren?"

Du möchtest keine Liste Pro/Contra dokumentieren, oder? Du möchtest die Frage beantwortet haben, warum das während der Entwicklung passieren soll.

Contra:
- Keine Zeit zum Kommentieren. (Nicht meine Meinung, höre ich aber manchmal).

Pro:
- Designentscheidungen werden transparent. Warum habe ich zum Zeitpunkt des Codens mich für einen bestimmten Algorhythmus entschieden.
- Erfahrungsgemäß wird im Nachhinein nicht mehr kommentiert.
- Man kann von einem Projekt temporär für ein wichtigeres Projekt (oder Krankheit oder ...) abgezogen werden. Der Status Quo ist dokumentiert.

Dirk

Kommentare schreibe ich auch fast keine, dafür eine ausführlichere POD-Dokumentation, da ich dann ausführlicher beschreibe was die Subroutine macht.

Wenn man dann noch versucht, die Subroutinen relativ klein zu halten, so dass nicht zig Sachen in einer einzigen Sub gemacht werden, dann klappt das eigentlich sehr gut. Dann finde ich mich in meinem Code auch noch nach Jahren zurecht...

Contra: "das brauche ich sowieso nie mehr"

den fehler mach ich auch immer :)

ich will mir irgendein kleines script porgrammieren, ganz schnell und ohne kommentare. ich bastle, bastle und bastle und irgendwann (nach ein paar stunden oder tagen) habe ich den perfekten code, der funktioniert. in ein- oder zwei wochen abstand kann ich mich noch dran erinnern. Nach drei wochen brauche ein teil des scriptes vielleicht für eine ähnliche aufgabenstellung. ich find nichts mehr! ich kann den code wegschmeißen und das script ebenso neu schreiben, bevor ich mich da in ein gewurschel hineinwage... also drei tage in den sand gesetzt!