Re: Source Code Dokumentation mit DocBook

Am Sonntag, 24. Oktober 2004 11:15 schrieb Bernhard Walle:
> * Stefan Lang <[email protected]> [2004-10-24 10:36]:
> > Ich soll den Quellcode für meine Diplomarbeit ausführlich dokumentieren
> > und frage mich ob es sich auszahlt das mit DocBook zu erledigen.
> > Es handelt sich dabei zur Zeit um ca. 22000 Zeilen in 37 Dateien
> > (könnte noch auf max. 35000 Zeilen wachsen).
>
> Das Problem bei Quellcodedokumentation mit DocBook ist, dass Quellcode
> und Dokumentation getrennt ist. Erstens muss man die Struktur des
> Codes in der Dokumentation duplizieren, zweitens vergisst man bei
> Änderungen im Quellcode gerne, die Dokumentation zu ändern.
>
> Ich empfehle daher Doxygen, wo man die Dokumentation in den Quellcode
> (z. B. Headerdateien) integrieren kann.
...

Danke für den Hinweis. Ich glaube ich habe mich falsch ausgedrückt.
Im Quellcode selbst befinden sich schon Kommentare so ähnlich wie
für Doxygen. Das was dabei herauskommt ist praktisch eine Dokumentation
des API.

Meinen Lehrern ist das leider nicht ausreichend.
Was noch fehlt wäre eine Gesamtübersicht, Klassenhierarchie
und allgemeine Beschreibungen, wie ein bestimmtes Problem gelöst
wurde und warum. Außerdem Beispiele an welchen Stellen man die
Quellen verändern muss um das Programm um bestimmte
Funktionalitäten zu erweitern usw.

Trotzdem vielen Dank,
Stefan

-- 
Um die Liste abzubestellen, schicken Sie eine Mail an:
    [email protected]
Um eine Liste aller verfügbaren Kommandos zu bekommen, schicken
Sie eine Mail an: [email protected]