Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

Re: Ways of commenting subroutines

by mbond (Beadle)
on Mar 28, 2001 at 22:53 UTC ( #67903=note: print w/ replies, xml ) Need Help??


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

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.


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://67903]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others surveying the Monastery: (8)
As of 2014-08-23 03:53 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    The best computer themed movie is:











    Results (172 votes), past polls