http://qs321.pair.com?node_id=397033


in reply to Re: Preferred method of documentation?
in thread Preferred method of documentation?

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;
  • Comment on Re^2: Preferred method of documentation?