I use a similar style, but I also try to include a header
section for the entire module that descibes what it does,
why it was created and any other notes necessary. I usually
include a $Id$ tag as well, just to make the version number
Since I also use CVS for my source code control, I have also
gotten in the habit of, at the very bottom of the POD, to
create a HISTORY section and putting a $Log$ tag in there.
It keeps the checkin history with the file, but doesn't
clutter either the top of the file or
r the POD with a lot.
I also have written code similar to yours to pull my sub headers
out and marginally PODify them. Check out this
node for one of my more interesting attempts ( the first
toy ) at documenting the possible return values for a module.
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:
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
- 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
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||