Beefy Boxes and Bandwidth Generously Provided by pair Networks Frank
good chemistry is complicated,
and a little bit messy -LW
 
PerlMonks  

Re: Ways of commenting subroutines

by mbond (Beadle)
on Mar 28, 2001 at 17:53 UTC ( [id://67903]=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

I forget the name of this commenting style, but its supposed to be a standard so that parsers can write the basic documentation for you.

#Requires:
#          var 1 to be valid <something>
#          var 2 to be valid <something>
#
#Returns:
#          var 1 is Preserver/Produces/Destroys

[download]

destroys means don't count on it being there, produces means that it is generated in that function and returned to the calling function and preserved means that it will return unchanged. mbond.

In Section Seekers of Perl Wisdom

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?

www.com | www.net | www.org
Node Status?
node history
Node Type: note [id://67903]
help
Sections?
Information?
Find Nodes?
Leftovers?
    Notices?
    • hippo‥ epoptai's answer Re: how do I set a cookie and redirect was blessed by hippo!
    • erzuuli‥ Anonymous Monks are no longer allowed to use Super Search, due to an excessive use of this resource by robots.