Beefy Boxes and Bandwidth Generously Provided by pair Networks
Welcome to the Monastery

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?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://637918]
and all is quiet...

How do I use this? | Other CB clients
Other Users?
Others perusing the Monastery: (5)
As of 2018-06-22 02:03 GMT
Find Nodes?
    Voting Booth?
    Should cpanminus be part of the standard Perl release?

    Results (120 votes). Check out past polls.