{"id":613,"date":"2010-12-01T02:22:01","date_gmt":"2010-12-01T00:22:01","guid":{"rendered":"http:\/\/blog.cipworx.org\/martin\/?p=613"},"modified":"2010-12-01T02:25:21","modified_gmt":"2010-12-01T00:25:21","slug":"perl-code-automatisch-dokumentieren","status":"publish","type":"post","link":"https:\/\/blog.cipworx.org\/laserman\/2010\/12\/01\/perl-code-automatisch-dokumentieren\/","title":{"rendered":"perl code automatisch dokumentieren"},"content":{"rendered":"<p>Heute war ich auf der Suche nach einem Tool um fremden &#8220;legacy&#8221; perl sourcecode zu dokumentieren. Von einem fr\u00fcheren php Projekt hatte ich doxygen noch in guter Erinnerung, aber doxygen alleine kann kein perl, das geht nur mit Hilfe von <a href=\"http:\/\/www.bigsister.ch\/doxygenfilter\/\">doxygenfilter<\/a>.<\/p>\n<p><code><br \/>\ndoxygen -g doxy.cnf<br \/>\n<\/code><\/p>\n<p>dann doxy.cnf bearbeiten:<br \/>\n<code><br \/>\n.<br \/>\n.<br \/>\nINPUT                  = bla.pl<br \/>\n.<br \/>\nFILE_PATTERNS          = \"*.pl\"<br \/>\nINPUT_FILTER           = doxygenfilter<br \/>\n.<br \/>\nSOURCE_BROWSER         = YES<br \/>\n.<br \/>\n.<br \/>\n<\/code><\/p>\n<p><code><br \/>\ndoxygen doxy.cnf<br \/>\n<\/code><\/p>\n<p>Vom Ergebnis bin ich nicht begeistert. Doxygen zeigt entweder den ganzen sourcecode oder eine Liste aller Funktionen.<\/p>\n<p><a href=\"http:\/\/suttree.com\/code\/doco\/\">doco<\/a> ist ganz nett, klein und einfach zu benutzen. Es erzeugt ein plaintext File bestehend aus Zeilennummern, allen Kommentaren aus dem Quelltext und den Funktionsnamen. <\/p>\n<p>Am besten gefallen hat mir <a href=\"http:\/\/www.naturaldocs.org\/\">Natural Docs<\/a> <\/p>\n<p><code>.\/NaturalDocs -i ~\/myproject\/ -o HTML ~\/myproject\/output\/ -p ~\/myproject\/NaturalDocs<\/code><\/p>\n<p>Es zeigt eine sch\u00f6ne interaktive ??bersicht \u00fcber alle Variablen und Funktionen.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Heute war ich auf der Suche nach einem Tool um fremden &#8220;legacy&#8221; perl sourcecode zu dokumentieren. Von einem fr\u00fcheren 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 = [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4],"tags":[128,127],"class_list":["post-613","post","type-post","status-publish","format-standard","hentry","category-linux","tag-dev","tag-perl"],"_links":{"self":[{"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/posts\/613","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/comments?post=613"}],"version-history":[{"count":3,"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/posts\/613\/revisions"}],"predecessor-version":[{"id":615,"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/posts\/613\/revisions\/615"}],"wp:attachment":[{"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/media?parent=613"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/categories?post=613"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.cipworx.org\/laserman\/wp-json\/wp\/v2\/tags?post=613"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}