I think almost everything was said in this node (some other interesting things could be found here)

Now For my part, chating with tilly convinced me that explicit function name, (and obviously code logic)
is definitly something to pay attention to
(mainly beccause of the code/comments synchronization problem):
For example your function could be renamed db_check_user_address()

Anyway even if it's obvious :
Pay more attention in writing clear code rather than trying to explain complex/strange/bad/obscure code.

NOTE: I've heard dkubb is working on a document, describing good coding practice, needless to say I'm impatient to read it...
(Especially when you see the quality of some of this post...)
Furthermore I see more and more questions about how to write good code? what is more elegant? how much a code should be documented? ...
I then think I'm not the only one who find perlstyle a little bit short.
And I really think that with all the skilled coders around, the monastery could produce a good answer...

"Only Bad Coders Badly Code In Perl" (OBC2IP)

In reply to Re: Ways of commenting subroutines by arhuman
in thread Ways of commenting subroutines by stephen

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


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.