Perl POD Notion

Perl Syntax – Part 7

Perl Course

Foreword: In this part of the series I give you a notion on POD.

By: Chrysanthus Date Published: 13 Jun 2015

Introduction

This is part 7 of my series, Perl Syntax. POD stands for Plain Old Document. In this part of the series I give you a notion on POD. You should have read the previous parts of the series before reaching here, as this is a continuation.

Comment
A line comment in Perl is like this:

#the comment until the end of line.

You begin with # and then any text from there to the end of the line, is a comment.

What if you have notes of more than one line, to put in places in your program? The solution is to use POD.

POD Notion
If you want comment in the form of a note, you have to use POD. The note will take more than one line.

POD begins with:

=Text Identifier of your choice.
Your notes in many lines including blank lines, and then
=cut

So you start with the equal sign. This is followed by identifier of your choice. Then you have your notes. At the end of the notes you must have a new line of, =cut.

Everything from =Text Identifier to =cut, is ignored by the Perl compiler.

Format of POD
Even though POD is ignored by the compiler, it has its own software readers. If you want a software reader to read your POD, then you do not have to type the POD arbitrarily. There is a format for typing PODs, and a good POD can be converted into an HTML document. However I will not talk about the format in this series. I will talk about it in a different series.

That is it for this part of the series.

Chrys

Broad Network

Related Articles

Perl POD Notion

Perl Syntax – Part 7

Perl Course

Introduction

Related Links

Comments