Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Re: Danger, danger Will Robinson (documenting code)

by WebHick (Scribe)
on Mar 30, 2001 at 08:42 UTC ( [id://68276]=note: print w/replies, xml ) Need Help??


in reply to Danger, danger Will Robinson (documenting code)

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';
#This needs to be here. You can change it if you want $b = '5';
and the famous:
#Set this to 1 if your system implements it. $x = '0';

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

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://68276]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (5)
As of 2025-06-16 22:44 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?
    erzuuliAnonymous Monks are no longer allowed to use Super Search, due to an excessive use of this resource by robots.