IMHO just the fact that you comment your code is laudable in and of itself. Too many times I have had to go in and update | manitain | and ultimately re-write sloppy, uncommented code and cursed the entire time at the lack of comments.
I agree with the other monks that converting your comments to POD makes more sense, however, I find that "flower box" comments are invaluable to me and my colleagues. As I am the only Perl coder in my group of admins (a mix of *nix and Win32) and the only fervently open-source coder, I find that this style of commenting lends itself to an easier interpretation for non-Perl coders (especially when most on the team don't even know what a perldoc is).
-hieronymus
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, 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
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.
|
|