My boilerplate is:
package ModuleTemplate;
########...
#
# (legal stuff here)
#
########...
use strict;
use warnings;
use diagnostics;
=head1 NAME
ModuleTemplate - Template for new perl modules
=head1 SYNOPSIS
Describe basics of how to use this module
=head1 DESCRIPTION
Describe the module
=head1 FUNCTIONS
Describe the functions
=over 4
=item [function_name]
[Describe what this function is about]
Parameters:
=over 4
=item [param1]
[Describe param1]
=item [param2]
[Describe param2]
=back
Returns: [be sure to label all returns, including differences for arra
+y vs
scalar context]
=cut
sub function_name
{
}
=back
=head1 AUTHOR
(my team name is here)
=head1 COPYRIGHT
Copyright 2005 (my company)
(more legal stuff)
=head1 BUGS
No known deficiencies
=cut
1;
For open-source stuff like goes on CPAN, I don't have a boilerplate. At least, not yet. :-)
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|