I usually copy over Build.PL and Makefile.PL (compatibility mode) from an existing module.
Laying out documentation is my least favorite part of writing. I use a vim macro to insert a POD skeleton: map ,pod <ESC>:r ~/bin/data/base.pod<CR>. That includes this file:
__END__
=head1 NAME
=head1 SYNOPSIS
=head1 DESCRIPTION
=head1 METHODS
=over 4
=back
=head1 AUTHOR
chromatic
=head1 BUGS
No known bugs.
=head1 COPYRIGHT
Copyright (c) 2003, chromatic. All rights reserved. This module is d
+istributed under the same terms as Perl itself,
in the hope that it is useful but certainly under no
guarantee.
It's a lot easier to write my documentation then.
-
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
or How to display code and escape characters
are good places to start.
|