The POD Template
A POD document has many sections, and remembering them all can be difficult. The technique I use is to start with a template, fill in the sections I need, delete the sections I don’t, and thus get good documentation: (This template is rather long. Cut it down and only use the sections which are relevant to your situation.)
=pod =head1 NAME program – a program that does something useful =head1 SYNOPSIS program [–x] [–x=<value>] <file> [<file> ...] =head1 DESCRIPTION The I<program> does something very useful. =head1 OPTIONS The I<program> takes the following arguments: =over 4 =item B<–x> An option that's just a single letter. =item B<–x=>I<value> An option that takes a I<value> as an argument. =back =head1 RETURN VALUE Exit ...
Get Perl for C Programmers now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
