Beefy Boxes and Bandwidth Generously Provided by pair Networks
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

print "hallo"; <<__DOC__; nothing happens here __DOC__ print " world!";

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":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others pondering the Monastery: (3)
As of 2024-04-24 20:22 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found