Keep It Simple, Stupid | |
PerlMonks |
comment on |
( [id://3333]=superdoc: print w/replies, xml ) | Need Help?? |
Perl module document embedding is described in perlpod (Plain Old Documentation).
For starting points, you can look at any module that's probably included with perl to get an idea of what goes where. Of late, one consideration is between putting all the module documentation in one block (typically at the end), or in separate blocks, such that function calls have their documentation right next to them. To perldoc, this makes no difference, but it all depends on your programming style and how you comment functions.
-----------------------------------------------------
In reply to Re: Documenting a Module
by Masem
|
|