develooper Front page | perl.beginners | Postings from February 2002

Re: UFO (Unidentified Formatting Observation) on the web....

Thread Previous | Thread Next
From:
Chas Owens
Date:
February 1, 2002 07:54
Subject:
Re: UFO (Unidentified Formatting Observation) on the web....
Message ID:
1012578851.15605.3.camel@tert.icallinc.com
On Fri, 2002-02-01 at 10:44, Ron Goral wrote:
> I have a very beginner's question.  I've just been looking at the code for a
> library file and noticed some, to me, very peculiar things.  First, there is
> text that is not commented, it is just typed in place.  Why does this not
> interfere with the script?  Second, there are expressions like "=pod" and
> "=cut" and "=head1".  What do these mean?  Third, there is a "1;" at the
> very end of the file.  I've seen that before, but what is the purpose?
> Fourth, there is text like "I<delete_cookie> blah blah" and "B<MUST>" (I
> assume that this last is a comment on text decoration).  Can anyone tell me
> what these mean?  Is there a difference in a library file and a regular
> script file that allows for this?   Is there some tutorial or documentation
> about the differences in writing a library/module versus a normal script
> file?
> 
That is POD (Plain Old Documentation).  POD is a method of documenting
Perl code be it a script or a library.  See "perldoc perlpod" for more
information.  

The 1; at the end of the file is necessary for libraries only.  See
"perldoc perlmod" for more information.
 

-- 
Today is Boomtime the 32nd day of Chaos in the YOLD 3168
All Hail Discordia!

Missle Address: 33:48:3.521N  84:23:34.786W


Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About