I use block comments to explain the implementation, and POD to explain the usuage. And IMO, if you use only POD, you either have lousy
manual pages, or your code is very lousy documented.
On several occasions a monk
who we all think highly
of, let me know that good code comments itself. If you
choose the names of variables and functions carefully, their
function in the program becomes clear
without separate comments.
Comments appear to have the tendency
to get out of sink with the code after some reviewing/
debugging rounds. So if you don't need comments at all,
your code is better in the long run. I won't claim that
I can write such code although I try, and I still feel more
comfortable with comments all over the place.
This of course has nothing to do with inline/EOF POD.
I see the general case for EOF PODs, but I can think of
modules where inline PODs come more natural. If the module
only exports a series of reasonable independent functions
(so no OO), the interface-PODs can perfectly stay with the exported
functions. But even than general usage and example docs
are probably better situated EOF.
"We are not alone"(FZ)
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.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||