[Okta Webinar] Learn how to a build a cloud-first strategyRegister Now


Documentation?  Inside the script?  POD?

Posted on 2006-06-05
Medium Priority
Last Modified: 2009-07-29
Is it possible to put POD documentation inside a perl script?
Have a link to writing "POD" documentation 101?
How do you document, at the user level, your scripts made for company wide use?

Question by:hank1
LVL 12

Accepted Solution

geotiger earned 260 total points
ID: 16833218
> Is it possible to put POD documentation inside a perl script?

>Have a link to writing "POD" documentation 101?
You can find out POD from Perl documentation by typing:
perldoc perlpod

>How do you document, at the user level, your scripts made for company wide use?
I use a lot of inline documentation and try to document each method/function/subroutine using the following style:

=head1 METHODS

This program includes the following methods:

=head3 print_form ($q, $ar)

Input variables:

  $q    - CGI object
  $ar   - Parameter array reference

Variables used or routines called:

  Parameters in $ar:
    ora_ifn - input and user interface configuration file name
  External subs:
    echo_msg - display messages
How to use:

  $s->print_form($q, $ar);

Return: None.

This method reads a configuraton file and display the CGI form.



Assisted Solution

Perl_Diver earned 240 total points
ID: 16835955
here's the link: http://perldoc.perl.org/perlpod.html

Check the SEE ALSO section at the bottom of the page

bookmark the site:  http://perldoc.perl.org

Featured Post

Concerto Cloud for Software Providers & ISVs

Can Concerto Cloud Services help you focus on evolving your application offerings, while delivering the best cloud experience to your customers? From DevOps to revenue models and customer support, the answer is yes!

Learn how Concerto can help you.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

I've just discovered very important differences between Windows an Unix formats in Perl,at least 5.xx.. MOST IMPORTANT: Use Unix file format while saving Your script. otherwise it will have ^M s or smth likely weird in the EOL, Then DO NOT use m…
A year or so back I was asked to have a play with MongoDB; within half an hour I had downloaded (http://www.mongodb.org/downloads),  installed and started the daemon, and had a console window open. After an hour or two of playing at the command …
Explain concepts important to validation of email addresses with regular expressions. Applies to most languages/tools that uses regular expressions. Consider email address RFCs: Look at HTML5 form input element (with type=email) regex pattern: T…
Six Sigma Control Plans
Suggested Courses

834 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question