Wie dokumentiert ihr?

[Mr.Undertaker]

Also ich bin der Meinung, dass Code nur "gering" zu kommentieren ist. Also nur die nötigen "Kleinigkeiten", wie z.B was der Abschnitt macht und für was diese spezielle Variable da ist.

Wie die Klassen miteinander agieren, sollte in eine richtige externe Dokumentation. Um so etwas darzustellen, nimmt man ein UML-Diagramm. Tools die UML-Diagramm erstellen sind z.B. Rational Rose, Borland Together oder MS Visio.
Naja, aber auch das sollte man eigentlich vorher machen, da diese Programme ja auch den nötigen Quelltext erstellen können.

Jetzt hab ich wahrscheinlich mehr verwirrt als geholfen, sorry

 

[canuzzi]

Also den "inneren" Code zu dokumentieren, halte ich auch fuer sehr wichtig. Schon fuer einen selber, manchmal kann es echt hart sein zu vertsehen was man da so gemacht hat und warum. Da ist ein bischen Kommentar nicht schlecht. Ich habe mir inzwischen auch angewoehnt, zuerst den Kommentar zu schreiben und dann zu coden, dass hilft auch beim Design und der Programmierung. Also Beispielweise:

/* Funktion macht foo */

/* Algorithmus macht bar */

/* Jetze fooe herum bis alles bar */

/* usw. */

 

[jccTeq]

UML-Diagramme...jipiieh... naja, sie haben ja ihre Daseinsberechtigung. Aber welche Software benutze ich, wenn es sich bei meinem Programm um ein Linux-Programm handelt, dessen Code ausschließlich mit 'nem Texteditor erstellt wurde. Also komplett by Hand ohne Assistenz-Programme (Visual Studio o.ä.). Was für Doku-Software gibt es da außer doxygen noch?