On Tue, May 27, 2003 at 12:12:12PM -0400 Paul Kraus wrote:
> Reading through the doc's it says that it is preferred that you write
> the -h help info using POD.
Which docs state that?
> How is this down? Any links on how to write
> pod or have a perl script display pod for built in help.
Pod::Usage is a module that can spit out the embedded POD-sections. I
never used it, though.
Other than that, POD is documented throughout the perldocs. Read
perlpod.pod
perlpodspec.pod
"PODs: Embedded Documentation" within perlsyn.pod
> Do you guys really use POD to document your apps instead of #comments?
PODs and #comments serve two different purposes. I use comments for
commenting the code...these comments are for me, the programmer.
Documentation for the end-user of either the program or module however
is usually done with POD. The -h switch, though, simply emits a stripped
down version of the pods. Have a look at the source of the tools that
come with perl itself, such as h2xs or the perldoc-program. What is
printed when issuing them with -h is usually not typesetted with POD but
produced with an ordinary 'print STDERR <<EOHELP;'.
Tassilo
--
$_=q#",}])!JAPH!qq(tsuJ[{@"tnirp}3..0}_$;//::niam/s~=)]3[))_$-3(rellac(=_$({
pam{rekcahbus})(rekcah{lrePbus})(lreP{rehtonabus})!JAPH!qq(rehtona{tsuJbus#;
$_=reverse,s+(?<=sub).+q#q!'"qq.\t$&."'!#+sexisexiixesixeseg;y~\n~~dddd;eval
--
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
