Ted Pedersen wrote on 10/18/09 8:31 AM:

> If you look at CPAN....
> 
> http://search.cpan.org <http://search.cpan.org>
> 
> most of the modules contained therein use this style - that's the
> style we want to use as well (with those same sections and same level
> of commentary). Then, in your code you should also try to have more
> detailed comments regarding what is happening at different sections of
> the code.
> 

Since you plan to release code to CPAN, let me recommend Module::Starter as
helpful to have in your toolkit.

 http://search.cpan.org/dist/Module-Starter/

I especially like the ability to define my own template, so that I can include
common boilerplate like licensing/copyright info, contact, and repository
information, and layout the POD section according to a convention both amenable
to CPAN and to the way I like to construct my documentation.

-- 
Peter Karman  .  http://peknet.com/  .  [email protected]

Reply via email to