laserman's blog

Heute war ich auf der Suche nach einem Tool um fremden “legacy” perl sourcecode zu dokumentieren. Von einem früheren php Projekt hatte ich doxygen noch in guter Erinnerung, aber doxygen alleine kann kein perl, das geht nur mit Hilfe von doxygenfilter.


doxygen -g doxy.cnf


dann doxy.cnf bearbeiten:

.
.
INPUT = bla.pl
.
FILE_PATTERNS = "*.pl"
INPUT_FILTER = doxygenfilter
.
SOURCE_BROWSER = YES
.
.



doxygen doxy.cnf


Vom Ergebnis bin ich nicht begeistert. Doxygen zeigt entweder den ganzen sourcecode oder eine Liste aller Funktionen.

doco ist ganz nett, klein und einfach zu benutzen. Es erzeugt ein plaintext File bestehend aus Zeilennummern, allen Kommentaren aus dem Quelltext und den Funktionsnamen.

Am besten gefallen hat mir Natural Docs

./NaturalDocs -i ~/myproject/ -o HTML ~/myproject/output/ -p ~/myproject/NaturalDocs

Es zeigt eine schöne interaktive ??bersicht über alle Variablen und Funktionen.

This entry was posted on Wednesday, December 1st, 2010 at 2:22 am and is filed under linux. You can follow any responses to this entry through the RSS 2.0 feed. You can skip to the end and leave a response. Pinging is currently not allowed.