Programmdokumentation??? Tools??
-
-
cppdoc
-
Braucht man sowas? Außer bei einer Bibliothek oder einem öffentlichen Interface, warum dokumentiert man das auf Funktionsebene? Was bietet die Doku, was man mit einer guten IDE nicht auch sehen kann?
Ich sehe das oftmals als Selbstzweck, daß man für 100.000 Zeilen Code auch 3,5MB an HTML-Dokumenten zum Quelltext mitliefern muß. ABER WO IST DIE DOKUMENTATION?
-
hehe ... ja ich weis .. ich kritzle neben bei schon mit .... ich schreib meine Diplomarbeit... und wollte halt den Code dokumentieren ... die eigentlich Programmbeschreibung dokumentation steht ja dann in meiner Diplomarbeit...
apropo Diplomarbeit, von euch haben doch sicher ein Paar erfahrunge über Software Dokumentation etc. Eine einheitliche Struktur wie man software beschreibt.. natürlich ist da ein wissenschaftlicher aspekt dahinter.. ich muss ja nicht alleine das programm beschreiben, sonst auch was ich mir dabei gedacht habe und wwelche wissenschaftliche inhalte die arbeit hat etc.
und das tool doxyen ist ja schon mal ganz gut für die alleinige Code Dokumentation:)
-
Also für Programmdokumentationen gibt es Standards. Ich glaub sogar nach DIN irgendwas.
Weis jetzt leider aber kein Link.
Könnte Dir aber Vielleicht ne Vorlage von mir per Mail schicken.MfG schirrmie
-
@schirrmie: jepp das wäre super.. hab dir hier ne e-mail geschreiben.. mit meiner adresse..
-
Ja so ein Link würde mich auch interessieren.
Und ob es ein einziges Programm gibt was aus so einem DIN Standard Zeugs dann nen schönes CHM File erstellen kann - so wie's doxygen eben macht. Oder Javadoc.Doxygen ist halt quasi der "de facto standard" was Dokumentieren von C++ angeht...
-
kennt jemand ne gute seite wo beispiel von den doxyen tags sind? also nicht nur die tags und beschreibugn, sondern auch beispiele wie man sie im quellcode anwendet...
-
Ja, in der Doku von Doxygen.
-
schirrmie schrieb:
Also für Programmdokumentationen gibt es Standards. Ich glaub sogar nach DIN irgendwas.
DIN 66 230 - Programmdokumentation
DIN 66 231 - Programmentwicklungsdokumentation
DIN 66 232 - Datendokumentation
