Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number
 
PerlMonks  

Re: Ways of commenting subroutines

by busunsl (Vicar)
on Mar 28, 2001 at 14:09 UTC ( #67792=note: print w/ replies, xml ) Need Help??


in reply to Ways of commenting subroutines

Most of the time I just use a one-liner for commenting subs.

I try to adhere to the following rules:

Use a self-explaining name for the sub, this will also explain the return value(s).
Use self-explaining names for the parameters, they are pulled in at the top of the sub, so they are seen immediately.
For subs used outside of the modules use pod.


Comment on Re: Ways of commenting subroutines

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others taking refuge in the Monastery: (6)
As of 2015-07-06 07:08 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...









    Results (70 votes), past polls