Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Re (tilly) 1: Another commenting question,

by tilly (Archbishop)
on Mar 16, 2001 at 00:28 UTC ( [id://64770]=note: print w/replies, xml ) Need Help??


in reply to Another commenting question,

What are you commenting and why? There isn't, IMO, any hard and fast rule.

My opinion is that most of the time, most code does not need commenting upon. But your public interfaces should always be commented. In my code what I intend to be public is generally fairly obvious - it is what you see comments next to. :-)

I explained my views in more detail in the thread starting at Re (tilly) 1: What you want and perl advocacy gone way wrong. (In that thread look for the post by IO, really.) I would also recommend The Pragmatic Programmer and Code Complete for two other books that offer good advice about the issues that commenting raises.

  • Comment on Re (tilly) 1: Another commenting question,

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others about the Monastery: (8)
As of 2024-04-23 12:18 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found