Beefy Boxes and Bandwidth Generously Provided by pair Networks
Problems? Is your data what you think it is?
 
PerlMonks  

Re: Too much documentation?

by Cirollo (Friar)
on Aug 14, 2001 at 00:08 UTC ( #104572=note: print w/ replies, xml ) Need Help??


in reply to Too much documentation?

Comments will never slow your code down. When your script is run, comments are simply thrown out, since they have no impact on the actual workings of the program.

The only disadvantage to having a huge amount of comments is that you may be causing confusion. Try to be concise and clear, but use as many words as you must to get your point across.

Bad comments are ones that are completely obvious simply from looking at the code. For example,

# Print the contents of the string variable $foo print $foo;
That comment would be worthless, since even a non-programmer can just glance at the code and tell what it does.


Comment on Re: Too much documentation?
Download Code

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (13)
As of 2014-07-28 18:46 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    My favorite superfluous repetitious redundant duplicative phrase is:









    Results (206 votes), past polls