Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Re: Ways of commenting subroutines

by arhuman (Vicar)
on Mar 28, 2001 at 13:44 UTC ( #67787=note: print w/ replies, xml ) Need Help??


in reply to Ways of commenting subroutines

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)


Comment on Re: Ways of commenting subroutines
Download Code

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others studying the Monastery: (7)
As of 2014-07-11 01:25 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    When choosing user names for websites, I prefer to use:








    Results (217 votes), past polls