Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

Re^3: Perl6 Pod -- reinventing the wheel? (=para)

by TheDamian (Priest)
on Nov 26, 2006 at 03:53 UTC ( #586069=note: print w/replies, xml ) Need Help??


in reply to Re^2: Perl6 Pod -- reinventing the wheel? (=para)
in thread Perl6 Pod -- reinventing the wheel?

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

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://586069]
help
Chatterbox?
and cookies bake in the oven...

How do I use this? | Other CB clients
Other Users?
Others surveying the Monastery: (6)
As of 2017-06-28 07:17 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    How many monitors do you use while coding?















    Results (628 votes). Check out past polls.