perl开发文档

 

 

代码

在一个Perl程序内部，可以嵌入一段文档以描述该程序的特点和使用方法。POD(Plain Old Documentation)是最常用的嵌入文档。
= pod：
该命令表示POD文档的开头，告诉Perl解释器无需解释其后的内容，直至遇到 " =cut " 命令。
= cut :
该命令用于表示一段POD文档的结束。
= head1
= head2：
这两个命令分别表示一、二级子段落。
= over：
表示开始一段列表
= back：
与 = over对应，表示结束列表
= item：
开始一个列表条目。必须在 " =over " 、 " =back " 对之间。在 " =over " 、 " =back " 对之间至少需要一个 " =item " 条目。
item一种特殊格式 " =item * " 表示一个条目后接一条水平线。

注意每个命令段落前后要有空行
示例如下：

= pod

author : xxx
date : xxx

= cut

= pod

function testAA
功能说明 :
输入参数：

= cut

 

转载于:https://www.cnblogs.com/itfriend/archive/2010/07/27/1786115.html