I understand the reasons behind inline POD, but I would have to fall into the camp of those who prefer EOF POD. This is especially true for package development. Here is my reasoning:
I tend of think of the usefulness of POD being for the people who are going to use my package. I don't want to have to spend time explaining to my other developers how to use my class; that's why I documented it in POD so they can do
perldoc MyClass. When I write the POD I do it as if I were writing documentation. Having everything in one place (at the end) makes it easier for me to see how it will look afterward.
I think this applies very much in the case of the person who is going to use your module, and less in the case of a person who is going to modify it. So the final tally is:
EOF POD is for class re-use.
inline POD is better for cooperative development.
Brian - a.k.a. DrSax
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.