JLI Spieleprogrammierung

[Wicky]

Jedes mal, wenn ich ein Programm schreibe, dann überlege ich mir, wie ich es am besten kommentieren soll und weiß es dann trotz einiger Überlegungen immer noch nicht.

Kann mir vielleicht jemand einen Tipp geben, wie ich es am Besten mit den Kommentaren anstellen soll? z.B.: Wie ausführlich sollten die Kommentare am besten sein? (Oder so was in der Art...)
Danke schon im Voraus!

[TheMillenium]

Ich schreibe die Kommentare immer so, dass ich selbst nach nem Jahr den Code wieder verstehen könnte...

...Ich verbrauche lieber 1, 10 oder 100MB für Kommentare anstatt später im dunklen herum zu tappen...

Ich schreibe z.B. für was ich die einzelnen Variablen deklariere....

...schreibe immer wie die einzelnen Funktionen zusammenhängen...

nicht was die einzelne Codezeile bewirkt...

sondern, ...mmmhh...ein Beispiel:

so nicht:

[Hazel]

Das wäre nahe am Idealfall:

1. Am Anfang der Datei: Nutzen, Datum der Erstellung, Autor, etc und ein kleines "Tagebuch" an denen Änderungen eingetragen werden mit Datum etc.

2. Zu jeder Funktion/Variable eine Erklärung

3. Innerhalb der Funktionen zu jedem Programmblock oder zu jeder Zeile ein Kommentar

Viel Spass
_________________
*click* Dabuu!?
Twitter: http://twitter.com/Ollie_R

[Michael]

Dem kann ich nur zustimmen. Ein gutes Programm soll hab ich mal irgendwo gelesen zu mind. 1/4 aus kommentaren bestehen.
Aber wichtiger als Kommentare sind meiner ansicht nach die namen für fgunktonen und variablen richtig zu vergeben. also am besten nicht immer for(int i = 0; i < WasWeisIch; i++) sondern statt i zb PosX oder so schreiben, das man schon am namen sieht was es soll
_________________
Es geht auch ohne

[Wicky]

Danke!!
Ihr habt mir sehr weitergeholfen.
_________________
erare humanum est