Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

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.

In reply to Adding POD Skeletons Automatically by chromatic
in thread Thoughts on making modules by BrentDax

Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":

  • 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.
Log In?

What's my password?
Create A New User
Domain Nodelet?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others taking refuge in the Monastery: (2)
As of 2022-06-26 16:41 GMT
Find Nodes?
    Voting Booth?
    My most frequent journeys are powered by:

    Results (86 votes). Check out past polls.