POD (Plain Old Documentation)

Perl uses a documentation format called POD (Plain Old Documentation). POD enables you to put the documentation for a program in the program itself. The system was designed to be simple and easy to use so that writing documentation would be easy.

The simplicity also makes it possible for people to create a wide variety of POD converters (pod2html, pod2man, pod2tex), which convert POD format documents into something more readable.

Documenting a Program

Suppose that you have written a program that converts US dollars to Hong Kong (HK) dollars, and you want to document it. You can do so by embedding POD documentation in the Perl script itself.

POD documentation begins with a line =pod and ends with =cut. Anything ...

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.