Beefy Boxes and Bandwidth Generously Provided by pair Networks
The stupid question is the question not asked
 
PerlMonks  

Re^2: What makes a comment "obnoxious"?

by adrianh (Chancellor)
on Sep 09, 2007 at 16:55 UTC ( #637918=note: print w/ replies, xml ) Need Help??


in reply to Re: What makes a comment "obnoxious"?
in thread What makes a comment "obnoxious"?

Your subs should be separated by meaningful comments that detail what the function does, what it expects as arguments, and what it returns

Or (even better!)

  • The function name should reveal what the function does. If it doesn't change it.
  • The name of the vars you rip out of @_ should reveal what the function takes. If they don't change them.

  • The name of the variable you a return() should reveal what is being returned. If it doesn't update it.

(guess who is thoroughly sick of lying comments in legacy code :-)


Comment on Re^2: What makes a comment "obnoxious"?

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others exploiting the Monastery: (15)
As of 2015-07-02 19:24 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...









    Results (44 votes), past polls