Dienstag, 4. März 2008

Source Code Documentation Generation Tools im Vergleich

Warum eine "externe" Doku schreiben, wenn der Code schon "intern" dokumentiert ist. JavaDoc hat es vorgemacht, es folgte PHPDoc und Konsorten. Sehr beliebt ist derzeit DoxyGen. Doch DoxyGen kann auch nicht alles (wenn auch das meiste). So kommt es bspw. nicht mit Javascript Literalen klar. Und das naechstbekanntere JSDoc leider auch nicht. Dann gibt es noch http://naturaldocs.org/ - aber das entlehnt sich schon wieder zu sehr der schon fast eingebuergerten JavaDoc Syntax - wobei der Ansatz sehr gefaellt. Was bleibt ist das relativ unbekannte jGrouseDoc von http://jgrouse.com/ - und siehe da, es wird von Google forciert..

um 00:46 | 3 Kommentare | Keine Trackbacks

< Schneller Tod - ein Tastendruck genuegt | CMSimple - was darf Open Source? >

Trackbacks

Trackback-URL für diesen Eintrag

Keine Trackbacks

Kommentare

Ansicht der Kommentare: (Linear | Verschachtelt)

Hier findet ihr eine tolle EinfÃ¼hrung in Doxygen, das ich persÃ¶nlcih als das mÃ¤chtigste Dokumentationstool ansehe:
http://www.netzwerk-des-wissens.de/ArtikelZusammenstellen_DB.php?artikel_id=29">Link

#1 Doku (Homepage) am 24.03.2008 17:42 (Antwort)

Hey, thanks a lot for kind words (I am jGrouseDoc developer). If you liked the older version I recommend upgrading to the latest one - it is much faster and has several new cool features

#2 Denis Riabtchik (Homepage) am 02.04.2008 02:11 (Antwort)

Hello Denis,

I am still using jGrouseDoc.

But I had to workaround something in the xslt files, as I wanted to configure whether the generated API doc contains all methods, or only the public ones (e.g. for an end user, the private ones are not necessary).

If you're interested I am send you the files. Would be nice if you can configure this in the xml file in the future?

#2.1 Airport1 (Homepage) am 02.04.2008 17:33 (Antwort)

Kommentar schreiben

Name
E-Mail
Homepage
Antwort zu
Kommentar: Umschließende Sterne heben ein Wort hervor (*wort*), per _wort_ kann ein Wort unterstrichen werden.
Standard-Text Smilies wie :-) und ;-) werden zu Bildern konvertiert.
Die angegebene E-Mail-Adresse wird nicht dargestellt, sondern nur für eventuelle Benachrichtigungen verwendet.

Um maschinelle und automatische Übertragung von Spamkommentaren zu verhindern, bitte die Zeichenfolge im dargestellten Bild in der Eingabemaske eintragen. Nur wenn die Zeichenfolge richtig eingegeben wurde, kann der Kommentar angenommen werden. Bitte beachten Sie, dass Ihr Browser Cookies unterstützen muss, um dieses Verfahren anzuwenden.

Hier die Zeichenfolge der Spamschutz-Grafik eintragen:
BBCode-Formatierung erlaubt
Sie können [geshi lang=LANG][/lang] Tags verwenden um Quellcode abhängig von der gewählten Programmiersprache einzubinden
: Daten merken?
Kommentare werden erst nach redaktioneller Prüfung freigeschaltet!