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

print "hallo";

<<__DOC__;

nothing happens here 

__DOC__


print " world!";

[download]

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)

update

see also ...

doxygen for perl?

DoxygenFilter & DoxyFilt

Doxygen Perl Filter on Windows

perl plugin for doxygen

Documentation system

Strategies for maintenance of horrible code?

Creating not so plain documentation

Perl Documentation, again. :(

Need advise on documentation support tools in Perl

In reply to Re: Shell/perl Documentation by LanX
in thread Shell/perl Documentation by Anonymous Monk

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.