Beefy Boxes and Bandwidth Generously Provided by pair Networks DiBona
Don't ask to ask, just ask
 
PerlMonks  

Re: Ways of commenting subroutines

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

This is an archived low-energy page for bots and other anonmyous visitors. Please sign up if you are a human and want to interact.


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.

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://67792]
help
Sections?
Information?
Find Nodes?
Leftovers?
    Notices?
    hippoepoptai's answer Re: how do I set a cookie and redirect was blessed by hippo!
    erzuuliAnonymous Monks are no longer allowed to use Super Search, due to an excessive use of this resource by robots.