• Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 665
  • Last Modified:

Documentation? Inside the script? POD?

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?

Thanks
0
hank1
Asked:
hank1
2 Solutions
 
geotigerCommented:
> Is it possible to put POD documentation inside a perl script?
Yes

>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.

=cut


0
 
Perl_DiverCommented:
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
0
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

Join & Write a Comment

Featured Post

Cloud Class® Course: Certified Penetration Testing

This CPTE Certified Penetration Testing Engineer course covers everything you need to know about becoming a Certified Penetration Testing Engineer. Career Path: Professional roles include Ethical Hackers, Security Consultants, System Administrators, and Chief Security Officers.

Tackle projects and never again get stuck behind a technical roadblock.
Join Now