To expand on Tye's comment, you could of course still write in a more
traditional Perl documentation style:
#!/usr/bin/perl
use strict;
use warnings;
=begin pod
=head1 A few good subs
This is a line of Pod. This module contains
some functions and might be used as follows:
do_something(); # Magic happens here!
=end pod
# ------------------
# Subroutines
# ------------------
=begin pod
=head2 do_something
You'd use this I<awesome> function for:
=item
When you want to do foo.
=item
When you want to do bar, since foo obviously
isn't cutting it.
=end pod
sub do_something {
print "Magic goes here.\n";
}
print "hi.\n";
do_something;
print "bye!\n";
...if you preferred.
I'd argue that this version is also much cleaner
and less intrusive than Texinfo or HTML (or even classic POD). Whether it's better than
the version I showed earlier is, I suspect, a matter of personal
preference. Some people will prefer the clarity of explicit tags, others will prefer the elegance of implicit contextual cues.
The point being, of course, that Pod is part of Perl 6, and hence TMTOWTDI.
Damian
-
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.
|