Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

Good commenting is a purely subjective concept -- good for who?

Like any form of documentation, without knowing who the intended audience is, it's impossible to say what makes good comments for them. For instance, there's detailed commenting (POD or other more detailed comments, which are good for long-term maintainers or folks who may make use of your work in other projects, but placing it all inline can possibly make it more difficult to follow the flow of the code.

I'd propose that well written code can be self-commenting. If you select good variable, package, and subroutine names, that clearly describe their purpose in an unambigous manner, you can signficantly cut down on the amount of comments necessary.

Take, for example, the same two equivalent functions:

# Set a default value if null # Input: # Test Value # Default Value # Output: # Sanitized Value sub nvl { return $_[defined($_[0])?0:1]; } sub sanitize_undefined { my $test_value = shift; my $default_value = shift; return $test_value if defined($test_value); return $default_value; }

That's not to say that comments never help -- I add comments all the time, but I'd rather make the code clear on its own, rather than add comments so the code can be understood. I see no point in obfuscation for the sake of obsfucation. (It might be obscure, because it's odd logic, or you're doing something strange to deal with a specific problem condition, or even for the sake of tuning, but just trying to keep someone from understanding your code results in you not understanding your own code a few months down the road).

Update: added readmore tags


In reply to Re: The art of comments: (rave from the grave) by jhourcle
in thread The art of comments: (rave from the grave) by BrowserUk

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others chanting in the Monastery: (4)
As of 2024-04-25 06:09 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found