P is for Practical | |
PerlMonks |
comment on |
( [id://3333]=superdoc: print w/replies, xml ) | Need Help?? |
I most wholeheartedly agree with the parent. I'd like to add, however, that a POD section granting an overview of the module is most helpful as well. Poke around on the CPAN docs -- many of the modules there are well-documented. Combine that style with that of jplindstrom above, and you have superb documentation that is both in-code and extractable using any one of the pod2 tools. The existence of pod2html also means that your documentation will be intranet-publishable, which looks great to your project manager.
radiantmatrix
require General::Disclaimer; In reply to Re^2: Preferred method of documentation?
by radiantmatrix
|
|