Thanks Peter, This is a great tip - I tried this out today and really like what I saw...
I installed in the usual way cpan > install Module::Starter and then ran the following command (there are other options available too...) module-starter --module Ted::TestModule --author="Ted Pedersen" [email protected] --license=gpl It set up the whole module structure for me, and did a nice job of setting up my perldoc/pod for me in the module ... this is good in that it hits most of the usual categories you find in the pod of CPAN modules, and it even gives little explanations of what should be there... Note that all of the below was generated automatically, ready to be edited! -------------------------------------------------------------------------------------------------------------------------------- package Ted::TestModule; use warnings; use strict; =head1 NAME Ted::TestModule - The great new Ted::TestModule! =head1 VERSION Version 0.01 =cut our $VERSION = '0.01'; =head1 SYNOPSIS Quick summary of what the module does. Perhaps a little code snippet. use Ted::TestModule; my $foo = Ted::TestModule->new(); ... =head1 EXPORT A list of functions that can be exported. You can delete this section if you don't export anything, such as for a purely object-oriented module. =head1 FUNCTIONS =head2 function1 =cut sub function1 { } =head2 function2 =cut sub function2 { } =head1 AUTHOR Ted Pedersen, C<< <tpederse at d.umn.edu> >> =head1 BUGS Please report any bugs or feature requests to C<bug-ted-testmodule at rt.cpan.or g>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Ted-TestMo dule>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. =head1 SUPPORT You can find documentation for this module with the perldoc command. perldoc Ted::TestModule You can also look for information at: =over 4 =item * RT: CPAN's request tracker L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Ted-TestModule> =item * AnnoCPAN: Annotated CPAN documentation L<http://annocpan.org/dist/Ted-TestModule> =item * CPAN Ratings L<http://cpanratings.perl.org/d/Ted-TestModule> =item * Search CPAN L<http://search.cpan.org/dist/Ted-TestModule/> =back =head1 ACKNOWLEDGEMENTS =head1 COPYRIGHT & LICENSE Copyright 2009 Ted Pedersen. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 dated June, 1991 or at your option any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. A copy of the GNU General Public License is available in the source tree; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. =cut On Sun, Oct 18, 2009 at 8:59 PM, Peter Karman <[email protected]> wrote: > > > > 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] > -- Ted Pedersen http://www.d.umn.edu/~tpederse
