Documentation style is a balance between what people find
easy to read, and what authors are going to actually write.
While it would be nice for beginners if people wrote
customized tutorials that explained material in
perltoot
in every module, that realistically is not going to happen.
And besides which, experienced Perl programmers won't want
to spend time wading through a recitation of standard
material.
The style popular in Perl is one from Unix. It is terse,
accurate, and to the point. Because it is terse, it is
easy for a module writer to follow the style and actually
document their complete module. So they do. Were it more
verbose, it would be harder to write hence less often
written, and harder to audit for errors, and therefore
would be less accurate.
But if you want to get a book, well you are going to have
to buy it. Because that is not the way that POD is used,
and people are generally not going to go out and verbosely
document just for fun...
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: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.