In my experience 90% of comments are unnecessary. But, on
the other hand, 90% of the comments that should
exist, are missing.
Yes, code should be 'self-documenting', but comments should explain why you're doing what you're doing.
It's no use being able to understand your regex or complex data structures etc if I can't work out why on earth you're doing things this way in the first place.
Of course, to bring this back to the initial point, if you break everything down into simple, short, self-contained functions that do only one thing, and are well
named, then it's going to be quite evident what they do,
and POD will mostly be sufficient :)
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.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||