It doesn't sound like anyone had mentioned this, but I'd like to add Parental Commenting to the list. When I started learning Perl, I downloaded a program off the Internet (I learn best by example) to help. I saw things such as:

#Don't change this.
$a = '1';

[download]
#This needs to be here.  You can change it if you want
$b = '5';

[download]
and the famous:
#Set this to 1 if your system implements it.
$x = '0';

[download]

The comments make me feel like the author is telling me not to play in the street because there's "stuff" in the street. He blindly assumes that I know the "stuff" are cars and that I know the make and model of each one.

Update: Due to several complaints, removed signature

Sarah

In reply to Re: Danger, danger Will Robinson (documenting code) by WebHick
in thread Danger, danger Will Robinson (documenting code) by jepri

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved 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, 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:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.