If you are hell-bent on doing that, and having doc-strings for your functions, the following style may be to your taste:
use vars %documentation;
sub doc($$) {
my ($for,$doc) = @_;
$documentation{ $for } = $doc;
};
doc('mysub1',<<'=cut');
=head2 C<< mysub1 >>
This documents mysub1. An example:
mysub1();
=cut
sub mysub1 {
...
};
doc('frobnicate',<<'=cut');
=head2 C<< frobnicate >>
This documents frobnicate. An example:
frobnicate();
=cut
sub frobnicate {
...
};
You will note from history that this style never caught on.
If you adhere to a strict documentation style, you may simply parse the POD and extract the function definitions from that. Using "docstrings" and parsing the module documentation are equivalent in that sense.
-
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.
|