good chemistry is complicated, and a little bit messy -LW |
|
PerlMonks |
Recommended subroutine documentation styleby markjugg (Curate) |
on Aug 27, 2000 at 20:24 UTC ( [id://29905]=perlquestion: print w/replies, xml ) | Need Help?? |
markjugg has asked for the wisdom of the Perl Monks concerning the following question:
Hello Monks,
I'm looking for a clean and compact style to document a subroutine interface with using POD. It needs to list out all the different possible input parameters, whether they are positional (like an array) or named (like a hash), what the possible values for each are, whether they are required or not, and what the default values are, if any. It also needs to explain possible return values.
Please provide a quick example of your preferred style, or give a pointer to a module that has a documentation style you think is compact and effective. Thanks! -mark
Back to
Seekers of Perl Wisdom
|
|