Home Accessibility Courses Diary The Mouth Forum Resources Site Map About Us Contact

Related technical and longer articles
POD (Plain Ole Documentation) - how to check it
Tips and short articles on this subject
Self help in Perl
Python - block insets help with documentation
Satisfaction of training
Well House Consultants
You are on the site of Well House Consultants who provide Open Source Training Courses and business hotel accommodation. You are welcome to browse and use our resources subject to our copyright statement and to add in links from your pages to ours.
Other subject areas - resources
Java Resources
Well House Manor Resources
Perl Resources
Python Resources
PHP Resources
Object Orientation and General topics
MySQL Resources
Linux / LAMP / Tomcat Resources
Well House Consultants Resources
Extras Resources
C and C++ Resources
Ruby Resources
Tcl/Tk Resources
Web and Intranet Resources
Perl module P306
Plain Old Documentation
Exercises, examples and other material relating to training module P306. This topic is presented on public course Perl for Larger Projects

Perl for Larger Projects - Objects, huge data, SQL databases, XML, efficiency and other topics. This advanced course takes the Perl programmer through ...
http://www.wellho.net/course/plfull.html  [course]
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 ...
http://www.wellho.net/mouth/668_Pyth ... ation.html  [short article]
The podchecker program (supplied as part of the most recent distributions) will take a Perl / POD source file and check the POD syntax for you: div ...
http://www.wellho.net/solutions/perl-pod ... ck-it.html  [longer article]
I'm writing this during a final-day practical on a Perl course - 10 trainees, coding quietly as mice, as they write a web page to calculate the length ...
http://www.wellho.net/mouth/242_Sati ... ining.html  [short article]
Perl's POD (Plain Old Documentation) system provides the programmer with the ability to add user documentation into his programs - allowing a single source ...
http://www.wellho.net/mouth/760_Self ... -Perl.html  [short article]
#!/usr/bin/perl # This is a demonstration of a POD =head1 A HELLO world program All training courses include a "hello world" program, and we would hate ...
http://www.wellho.net/resources/ex.php4?item=p306/pod1  [code sample]
$total = 0; for ($throw = 0 ; $throw < 4 ; $throw++) { print "Please enter value for throw ",$throw+1,": "; chop ($val = ); ...
http://www.wellho.net/resources/ex.php4?item=p306/d4  [code sample]

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

This topic is presented on public course Perl for Larger Projects

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
Pictures
Using Well House Consultant's laptops
Background information
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
Own-line directives.
Special formatting directives.
Embedded Directives.
Including POD within programs and modules.
Complete learning
If you are looking for a complete course and not just a information on a single subject, visit our Listing and schedule page.

Well House Consultants specialise in training courses in Python, Perl, PHP, and MySQL. We run Private Courses throughout the UK (and beyond for longer courses), and Public Courses 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.


© WELL HOUSE CONSULTANTS LTD., 2009: Well House Manor • 48 Spa Road • Melksham, Wiltshire • United Kingdom • SN12 7NY
PH: 01144 1225 708225 • FAX: 01144 1225 707126 • EMAIL: info@wellho.net • WEB: http://www.wellho.net • SKYPE: wellho