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

comment on

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

This is pretty well my stance. Variable names, sub names or anything that is functional should not be comedic unless the comedic name truly represents what is being used.

For comments, comedic things are fun to read in odd/rare circumstances, and very far edge case warnings as well (so long as the warn/error displays useful info inclusive).

I once patched a module that had a comment such as:

# we don't even know how why this is here, # nor how it is ever executed, Scotty

I looked at the code after I found that a far away test on CPAN Testers was failing, and realized that this sub was being called ONLY in a test and was never used otherwise. So I fixed the test, wrote a new test, and in the sub in the patch wrote something to the effect:

# this sub isn't ever used; beam it up, Scotty

In reply to Re^2: Does Humor Belong in Programming? by stevieb
in thread Does Humor Belong in Programming? by karlgoethebier

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 exploiting the Monastery: (7)
As of 2024-04-24 09:02 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found