Problems? Is your data what you think it is? | |
PerlMonks |
comment on |
( [id://3333]=superdoc: print w/replies, xml ) | Need Help?? |
regarding http://bahut.alma.ch/2007_08_01_archive.html I have to admit that I didn't know ':' was a no-op in sh.
I testet it with bash and it seems to work, you didn't say if only bourne-shell dialects are effected, otherwise you should test. (this is a Perl forum after all) Please note that practically the same trick also holds for Perl
Since you are free to chose your end_of_doc marker (here __DOC__) you can choose any "documentation markup language". But this will somehow slow down the execution of your script... If you better chose Doxygen or POD depends on what you want and if you have more Perl or sh scripts. IIRC one difference is that Doxygen automatically parses function-headers and variables of modules and creates browsable hierarchies. If you really need this you should search for doxygen bash solutions. Otherwise you should be more precise about WHAT KIND of documentation you wanna create! (Anyway you won't get much support for Doxygen here... :) see also doxygen vs POD
Cheers Rolf ( addicted to the Perl Programming Language)
updatesee also ...
Doxygen Perl Filter on Windows Strategies for maintenance of horrible code? Creating not so plain documentation Need advise on documentation support tools in Perl In reply to Re: Shell/perl Documentation
by LanX
|
|