Beefy Boxes and Bandwidth Generously Provided by pair Networks
Your skill will accomplish
what the force of many cannot
 
PerlMonks  

Re^2: The sourcecode *is* the documentation, isn't it?

by adrianh (Chancellor)
on Jun 15, 2004 at 09:56 UTC ( [id://366828]=note: print w/replies, xml ) Need Help??


in reply to Re: The sourcecode *is* the documentation, isn't it?
in thread The sourcecode *is* the documentation, isn't it?

Let the source code say what you are doing, add comments to say why you are doing it

I'd go a bit further and say that if you have to add comments to explain why you're doing it you should reconsider and see if there way you can rewrite your code to express your intentions more obviously.

Comments are a good thing if they make non-obvious code easier to understand. Even better is to make the non-obvious code more obvious.

  • Comment on Re^2: The sourcecode *is* the documentation, isn't it?

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others sharing their wisdom with the Monastery: (2)
As of 2024-04-26 03:37 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found