Exercises, examples and other material relating to training module P306. This topic is presented on public course Perl for Larger Projects
A file that contains a Perl program or a Perl module should also contain comments to help the maintainer in the future. It can also contain POD directives, which provide documentation for the user, either a user manual (for a program), or a description of the API provided (for a module).
Related technical and longer articlesPOD (Plain Ole Documentation) - how to check it
|Articles and tips on this subject||updated|
|760||Self help in Perl|
Perl's POD (Plain Old Documentation) system provides the programmer with the ability to add user documentation into his programs - allowing a single source file to include:
* The program itself
* Comments for future programmers who read the source
* Documentation for the user
Convertors such as pod2html ...
|668||Python - block insets help with documentation|
For many programmers, documenting their code is a chore, yet every piece of code that's going to be (re)used needs both instructions for the user, and adequate explanation of techniques for the code maintainer. The need for BOTH of these forms of support documentation is often overlooked by the newcomer, ...
Examples from our training material
|d4|| Sample code - alternatives to if and while|
|pod1|| Example of POD|
|pod1.html|| Example of HTML generated from POD|
PicturesUsing Well House Consultant's laptops
This module is available under an Open Training Notes License
for free download from http://www.training-notes.co.uk
Topics covered in this module
Special formatting directives.
Including POD within programs and modules.
If you are looking for a complete course and not just a information on a single subject, visit our Listing and schedule
Well House Consultants specialise in training courses in
. We run
throughout the UK (and beyond for longer courses), and
at our training centre in Melksham, Wiltshire, England.
It's surprisingly cost effective to come on our public courses -
even if you live in a different
country or continent to us
We have a technical library of over 700 books on the subjects on which we teach.
These books are available for reference at our training centre. Also
available is the Opentalk
Forum for discussion of technical questions.