Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

My initial response to this matter is that, all things considered, perhaps you should just examine all of the scripts and write a Word document that contains whatever comments you wish to make about them.   Simply talk to “the equally befuddled persons who are doomed to come after you,” and help them along.   I don’t necessarily interpret this requirement to mean that you should add POD-comments to each file.   (But, if at-all in doubt, ask your manager who gave you this assignment!!)

My opinion of Doxygen is that (a) it unquestionably delivers to you “what its designers intended,” but (b) that it is not terribly useful.   It is, after all, merely a digital algorithm.   I suspect that you have been tasked to “dive in to all of this (mess) and (please) come up with a useful set of bread-crumbs.”   If Doxygen can provide you with a useful-to-you and-to-your successors part,</em. then by all means use it.   But you, as a human being, will have to go from there to produce a final-product that is useful to the team.

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

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, 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, 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.
  • Log In?

    What's my password?
    Create A New User
    and all is quiet...

    How do I use this? | Other CB clients
    Other Users?
    Others scrutinizing the Monastery: (6)
    As of 2018-05-24 02:44 GMT
    Find Nodes?
      Voting Booth?