Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic
 
PerlMonks  

Re^2: Preferred method of documentation?

by radiantmatrix (Parson)
on Oct 06, 2004 at 15:38 UTC ( #397033=note: print w/replies, xml ) Need Help??


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?

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://397033]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others chanting in the Monastery: (3)
As of 2021-10-20 04:43 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    My first memorable Perl project was:







    Results (78 votes). Check out past polls.

    Notices?