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

Re: Re: Worst thing you ever made with Perl

by barrd (Canon)
on Sep 30, 2003 at 13:01 UTC ( #295268=note: print w/replies, xml ) Need Help??


in reply to Re: Worst thing you ever made with Perl
in thread Worst thing you ever made with Perl

... talk mainly about how to stick one big block of documentation at the top or bottom of the whole file...
That's one way of doing it (or looking at it) I guess, but what's to stop you from adding multiple blocks of POD?
#!/usr/bin/perl -w use strict; # codage... =head1 NAME doStuff function =head1 DESCRIPTION This sub is designed blah de blah blah and on and on etc ad infinitum =cut sub doStuff { # code for sub } # codage... =head1 NAME What the next line does =head1 DESCRIPTION This line uses some funky techniques I picked up from PM and does the following... =cut # insert incredibly funky bit of perl code here # carry on coding...
HTH, if not lemme know and I'll try to anser any more q's you have

Replies are listed 'Best First'.
Re: Re: Re: Worst thing you ever made with Perl
by Juerd (Abbot) on Sep 30, 2003 at 13:10 UTC

    =head1 DESCRIPTION This sub is designed blah de blah blah and on and on etc ad infinitum =cut

    That is bad POD style. It's like putting something like this on the monastery:

    DESCRIPTION

    This sub is designed blah de blah blah and on and on etc ad infinitum

    Indented paragraphs are verbatim and appear as they are, in a monospaced font. Don't do that unless it is code or you're using ASCII for lay-out.

    Juerd # { site => 'juerd.nl', plp_site => 'plp.juerd.nl', do_not_use => 'spamtrap' }

      Hi Juerd,
      That is bad POD style. ..
      Thanks for heads up, appreciated. Consider my hand smacked. ;)

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://295268]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others surveying the Monastery: (3)
As of 2021-03-01 03:27 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?