POD - "Plain Old Documentation" You'll find this in the perl doc as "perlpod"
basically you use the "=" in column one with a keyword. Perl parser ignores anything betweeen a beginning "=" and the final marker "=cut". Typically its: =pod =head1 DESCRIPTION blah, blah, blah... =cut code...... Other notes: 1. the "=" "=cut" markers can also be used to comment out code rather than each line as in: =comment code...... =cut 2. Use PerlOasis (a free windows based gui) to preview your POD (its all perl code): http://www.bahnhof.se/~johanl/perl/Oasis/ -----Original Message----- From: Richard Heintze [mailto:[EMAIL PROTECTED] Sent: Monday, June 07, 2004 6:06 PM To: [EMAIL PROTECTED] Subject: RE: How do I document my perl code? Is there any standard for documenting functions? For example, in Javadoc, there is a specific format that uses the "@" for identifying and formating the function argruments. It looks like POD much more freeform and is not nearly so detailed. Is that true? Siegfried P.S. Sorry Charles, I accidently replied to you personally. __________________________________ Do you Yahoo!? Friends. Fun. Try the all-new Yahoo! Messenger. http://messenger.yahoo.com/ -- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] <http://learn.perl.org/> <http://learn.perl.org/first-response> -- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED] <http://learn.perl.org/> <http://learn.perl.org/first-response>
