Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change

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.

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://104572]
[choroba]: LanX I miss working in a bank sometimes...
[Corion]: Discipulus: Ooof. Especially yearly things are things I like to automate instead of trying to remember how I did things last year...
[Corion]: And the second rule that I've learned is, that there is no one-off job, so writing a program for it pays off almost immediately. The third rule is to give all my programs numbers and have them reproduce that number in the name of their output files. :)
[Discipulus]: the true part is that also specification change between years.. but well our job is cheap but dont abuse of us.. ;=)
[LanX]: Choroba: do you miss chaos with ties? apply at the US government.. ;)
[ambrus]: Corion: those are good rules.
[ambrus]: Discipulus: oh sure. the input data has different filenames every time I get them.

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (14)
As of 2017-03-29 12:12 GMT
Find Nodes?
    Voting Booth?
    Should Pluto Get Its Planethood Back?

    Results (350 votes). Check out past polls.