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
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
Outside of code tags, you may need to use entities for some characters:
| |
For: |
|
Use: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
|
|
