 | Chapter 26: Plain Old Documentation |  |
We hope you document your code, whether or not you're a Random Hacker. If you do, you may wish to include the following sections in your pod:
The name of your program or module.
A one-line description of what your program or module does (purportedly).
The bulk of your documentation. (Bulk is good in this context.)
Who you are. (Or an alias, if you are ashamed of your program.)
What you did wrong (and why it wasn't really your fault).
Where people can find related information (so they can work around your bugs).
The copyright statement. If you wish to assert an explicit copyright, you should say something like:
Many modules also add:Copyright 2013, Randy Waterhouse. All Rights Reserved.
This program is free software. You may copy or redistribute it under the same terms as Perl itself.
One caveat: if you're going to put your pod at the end of the file, and you're using an __END__ or __DATA__ token, make sure to put an empty line before the first pod directive:
Without the empty line before the =head1, the pod translators will ignore the start of your (extensive, accurate, cultured) documentation.__END__ =head1 NAME Modern - I am the very model of a modern major module
|  | |
| 26.4. Pod Pitfalls |  | 27. Perl Culture |
Copyright © 2001 O'Reilly & Associates. All rights reserved.
HIVE: All information for read only. Please respect copyright! |
