IMHO, it depends. If you don't have some version control to rely on, it can provide extra documentation to someone. Let's take a trip to the real world: you have a long script
which processes files in different loops in different ways, and some PHB says, don't 'blurk' the 'B' files, and you
figure out that that means changing this:
for $filename (@filelist) {
...
to this:
for $filename (@filelist) {
# PHB doesn't want B files blurked
next if $filename =~ /^b/i;
...
A week later some other PHB is asking why the B-files aren't
being blurked, and grudgingly gets the other PHB to agree
that it should be changed back. Do you comment out that line, or delete it?
Two weeks later they decide that they really do want
the b-files blurked, and you're out on holiday or have quit
to preserve you sanity, and some
other programmer who is not too familiar with the code has to figure out what exactly needs to
be changed. It may be a poor man's CVS (which is odd considering
CVS is free), but that commented out
line really helps him, and he buys you a beer when you
get back. The trick, of course, lies in knowing what
should be commented out and what should be deleted :-)
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, details, 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, summary, 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.