... talk mainly about how to stick one big block of documentation at the top or bottom of the whole file...
That's one way of doing it (or looking at it) I guess, but what's to stop you from adding multiple blocks of POD?
#!/usr/bin/perl -w
use strict;
# codage...
=head1 NAME
doStuff function
=head1 DESCRIPTION
This sub is designed blah de blah blah
and on and on etc ad infinitum
=cut
sub doStuff {
# code for sub
}
# codage...
=head1 NAME
What the next line does
=head1 DESCRIPTION
This line uses some funky techniques I picked
up from PM and does the following...
=cut
# insert incredibly funky bit of perl code here
# carry on coding...
HTH, if not lemme know and I'll try to anser any more q's you have
-
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.
|
