Perl pod document use = head = cut = pod pod2text to implement the Program usage description

= Head1 name

The name of your program or module.

 

= Head1 synopsis

A one-line description of what your program or module does (purportedly ).

 

= Head1 description

The bulk of your documentation. (bulk is good in this context .)

 

= Head1 author

Who you are. (or an alias, if you are ashamed of your program .)

 

= Head1 bugs

What you did wrong (and why it wasn' t really your fault ).

 

= Head1 See also

Where people can find related information (so they can work around your bugs ).

 

= Head1 Copyright

The copyright statement. If you wish to assert an explicit copyright, you shoshould say something like:

Copyright 2013, Randy Waterhouse. All rights reserved.

 

Note: Each = label must have a line up or down, otherwise it will be incorrectly parsed.

= For HTML or = for text

Is to treat the following single row as HTML or text, and its function is similar to = begin html/= end HTML; = begin text/= end text. You can process multiple rows between begin and end.

 

= Over 4

= Item someword

 

*************

 

= Item somewordelse

 

******

 

= Back

The preceding statement is to write a list that starts with "over", followed by the number of indentations per line in the list. End with = back.

= Cut is the sign for ending the pod block, separated from the program.

 

In Perl, you can use pod2html **. PM> **. html to generate pod documents in HTML format.

 

= Pod = cut can be used as multi-line comments of the program, as well as the usage description of the program, and the pod2text command can be used. Die ('pod2text $0 ');