Robed ones,

I'm going to embark on much PODing and I'd like to know if there is a "best practice" or guide in place for documentation, or more specifically, Perl documentation (and even more specific, argument syntax).

For example, it's common to surround optional arguments with square brackets. However, how does one convey that, say, a subroutine wants an array reference? (A) sub(\@array); (B) sub($array_ref); (C) sub([]); (D)? After re-reading that, I also assume it could be based on the context--if you know the exact name of an array you want (A or B), or just a quick list of things that normally aren't grouped (C).

That's just one example.

Normally I wouldn't be too particular about things like this, but my project is growing and there will be much POD spread across many files. I would love to keep these consistent and "best practice."

Just curious about what's out there,

Thanks!

In reply to POD conventions by eff_i_g

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.