Perl-Sensitive Sunglasses | |
PerlMonks |
Re: creating documentationby planetscape (Chancellor) |
on Dec 27, 2005 at 15:34 UTC ( [id://519346]=note: print w/replies, xml ) | Need Help?? |
One tool I especially like is These nodes might also help if you are searching for tools:
This might sound like stating the bleeding obvious, but make certain the examples in your Synopsis actually work... I've run across my fair share that don't. Also, in most cases, your user wants output (maybe this doesn't apply precisely to your case, but here goes anyway) - if it's non-obvious how to get output from your program, specify how to do it. Some modules I've come across have specialized print functions... some have really obscure methods... don't force your user to use Data::Dumper on likely-looking variables from your POD in vain attempts to get results. HTH, * Update: 2005-12-28 Kudos to both john_oshea and tfrayner for alerting me to the fact that my link above has been rendered usless by the foul creatures known as spammers... I have found what appears to be a good link to obtain DoxyFilt; the most recent version seems to be from August 24, 2005: Doxygen-0.84.tar.gz. Thanks again, guys!
planetscape
In Section
Seekers of Perl Wisdom
|
|