I use a similar style, but I also try to include a header
section for the entire module that descibes what it does,
why it was created and any other notes necessary. I usually
include a $Id$ tag as well, just to make the version number
quickly available.
Since I also use CVS for my source code control, I have also
gotten in the habit of, at the very bottom of the POD, to
create a HISTORY section and putting a $Log$ tag in there.
It keeps the checkin history with the file, but doesn't
clutter either the top of the file or
r the POD with a lot.
I also have written code similar to yours to pull my sub headers
out and marginally PODify them. Check out this
node for one of my more interesting attempts ( the first
toy ) at documenting the possible return values for a module.
mikfire
-
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.
|