18. POD SHOULD not be interleaved with the code, and is not an alternative for comments.
Comments and POD have two different purposes. Comments are there for the programmer. The person who has to maintain the code. POD is there to create user documentation from. For the person using the code. POD should not be interleaved with the code because this makes it harder to find the code.
There would be no need for this if Perl had multi-line comments. And please don't tell me about the Acme module. Or the infamous here-doc technique. This must change! This is so sad!
http://dev.perl.org/rfc/5.html
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.
|
|
Log In?
|
|---|
|
|
|
Chatterbox?
|
|---|
How do I use this? | Other CB clients
|
|
Other Users?
|
|---|
Others drinking their drinks and smoking their pipes about the Monastery: (4)
As of 2020-01-21 22:34 GMT
|
|
Sections?
|
|---|
|
|
|
Information?
|
|---|
|
|
|
Find Nodes?
|
|---|
|
|
|
Leftovers?
|
|---|
|
|
|
Voting Booth?
|
|---|
|
|
|
Notices?
|
|---|
|
|
|
