Re: Ways of commenting subroutines

[mbond]

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.