I don't think you're going to get self-documenting code (how would you expect the code to know what it's doing, and be able to state that in a manner that the average user can understand?). You're going to have to write the documentation yourself. But there are tools to help you with that task.
One thing you can do is embed the documentation in the script itself, using POD (plain ol' documentation). That way, they can read up themselves by typing perldoc scriptname.pl
Read up on POD with man perlpod
Philosophy can be made out of anything -- or less
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
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.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||