<?xml version="1.0" encoding="windows-1252"?>
<node id="586069" title="Re^3: Perl6 Pod -- reinventing the wheel? (=para)" created="2006-11-25 22:53:49" updated="2006-11-25 17:53:49">
<type id="11">
note</type>
<author id="107600">
TheDamian</author>
<data>
<field name="doctext">
To expand on Tye's comment, you could of course still write in a more
traditional Perl documentation style:

&lt;blockquote&gt;
&lt;code&gt;
#!/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&lt;awesome&gt; 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";
&lt;/code&gt;
&lt;/blockquote&gt;

...if you preferred. 
&lt;p&gt;
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.
&lt;p&gt;
The point being, of course, that Pod is part of Perl 6, and hence TMTOWTDI.
&lt;p&gt;
Damian
</field>
<field name="root_node">
585945</field>
<field name="parent_node">
586066</field>
</data>
</node>
