Software-Inline-Dokumentation

Da kam im Gespräch mit einem Kollegen das Thema Inline-Dokumentation auf
und ob dieses oder jenes kennen würde.

Es scheinen immer mehr alternative Markup-Sprachen mehr oder weniger kurzfristig in Mode zu kommen,
sie heißen mark-down und anscheinend asciidoc.
Ich halte das für Quatsch.

Im PERL-Umfeld (und wir gingen vom PERL-Umfeld aus) ist eigentlich POD das richtige,
damit kann man PERL ganz toll inline dokumentieren.

Und dann kann man es mit Getopt::Long verheiraten
und bekommt eine Usage- oder andere Meldung hin,
die aus der Inline-Dokumentation abgeleitet ist.

Jede Sprache hat so ihre präferierte Methode, inline zu dokumentieren,
und bei PERL ist das eben POD,
bei Java Javadoc,
bei Ruby RDoc, …

Wenn ihr ein Beispiel für POD und die Kombination mit Getopt::Long brauchst,
dann lasst es mich wissen!

Wenn ihr allerdings nicht inline dokumentieren wollt,
dann ist wohl DocBook die Sache.
Und DocBook ist wirklich toll.
Und auch mit DocBook lassen sich man-pages gestalten und generieren.

This site uses Akismet to reduce spam. Learn how your comment data is processed.