Dokumentation aus Sourcen generieren?

[TheDodger]

moin ... auch wenn's schon halb 5 ist :D

Ich dokumentiere meine Sourcen so, wie ich es mir bei QT abgeschaut habe und möchte nun daraus ebenfalls eine HTML-Dokumentation erstellen.
Hat jemand von euch einen Plan, wie ich das am einfachsten machen (lassen) kann?

[anda_skoa]

Hi,

Wir benutzen dazu in der Firma doxygen.

Das macht erstklassige HTML Doku. Mit einem Zusatzttool, dessen Name mir jetzt natürlich nicht einfällt :( kann man daraus sogar UML Diagramme erzeugen lassen :p

Ciao,
_

[TheDodger]

hab ich grad mal ausprobiert ...
hmmm ... kdoc macht das ganze IMHO _fast_ genauso :D

Allerdings ... wo muß ich denn jetzt meine Comments hinschreiben in die Header Dateien?
In meiner Doku befindet sich ... nicht's ausser den Funktionen.

[anda_skoa]

Ja, kdoc machtdas auch :D
Hat aber eine bischen andere Syntax.

Soweit ich weiß muß der Kommentar in den header.

Wenn man außer
// fixxxme
;)
Kommentare im Source braucht, sollte man überlegen ob man es nicht besser machen kann.

Geht natürlich nicht immer, aber ansich sollte der Code selbsterklärend sein, wenn er kein Hack ist. :)

Ciao,
_

[TheDodger]

naaaahhhhhh, kein Hack :) nur mittlerweile so umfangreich (wie nunmal eine eigene String-Klasse sein kann), daß ich schon ganz gern eine entsprechende Doku dazu haben / anbieten möchte ...

Bodo 'der-schon-wieder-mal-beim-kunden-sitzt' Schulz :D

[anda_skoa]

Hehe, ich meinte ja cuh nciht die Interace Doku, dass ist wirllich eher ein Muß.

Ich meinte Kommentare im source file, so Sachen wie:
// have to check blah, because foobar migth ahve changed it
:D

Ciao,
_

[trag]

das zusatztool nennt sich dot, mit dem man klassendiagramme malen kann... aber uml soll auche gehen??? ist mir neu. got ist im paket graphviz inkludiert! irgendwo bei at&t technologies schwirrt das herum.

trag

[rup]

ich habe hier auf meinem Rechner ungetestet:

"htags - generate hypertext from C, C++, Yacc, Java and assembler source code"