内嵌的POD文档
时间：2006-10-13 来源：linxh
1 什么是POD文档
在一个Perl程序内部，可以嵌入一段文档以描述该程序的特点和使用方法。POD(Plain Old Documentation)是最常用的嵌入文档。
2 POD文档的格式
POD文档是一种简单的文本文档。它包含一些命令和表示符，用于格式化文本。一个POD文档包含三种段：逐字段（字面段落 Verbatim Paragraph）、命令段、通用文本段。
逐字段通常被有意义的区分开来；即通常以空格或TAB开头。逐字段的文字就是它本来的意思，不包含特殊的格式化命令或标记。pod2html时用<pre>将其包围。所以字面段落非常适合在引用语言与代码块时运用。
命令段应该以"="开头，后面接用于格式化段落的命令。如：
=head1 heading
=head2 heading
=item next
=over N
=back
=cut
=pod
=for X
=begin X
=end X
下面对这些命令做一下解释：
=pod：
该命令表示POD文档的开头，告诉Perl解释器无需解释其后的内容，直至遇到"=cut"命令。
=cut:
该命令用于表示一段POD文档的结束。
=head1
=head2：
这两个命令分别表示一、二级子段落。
=over：
表示开始一段列表
=back：
与=over对应，表示结束列表
=item：
开始一个列表条目。必须在"=over"、"=back"对之间。在"=over"、"=back"对之间至少需要一个"=item"条目。
item一种特殊格式"=item *"表示一个条目后接一条水平线。
=for
=begin
=end：
用于插入其他格式的文本。for后应带一词，制定接下来一句的格式。例如
=for html <br>
<p>HTML文本</p>
"=begin"、"=end"命令与"=for"类似。他们成对使用来包含其他格式的文本。例如：
=begin html
<br><p>HTML文本</p>
=end html
通用文本段是POD文档中的描述文字，但是包含一些特殊的标记，用于格式化文本的显示和超级链接。
I<text>:用斜体表示text
B<text>:用粗体表示text S<text>:包含了非中断的空格的文本 C<code>:表示语法代码 L<name>:表示一个超级链接。用法： L<name>：链接到另一页面 L<name/ident>：链接到页面中的列表条目。 L<name/"sec">：链接到其他页面的区域 L<"sec">：链接到本页的其他区域 F<file>:用于文件名 X<index>:指明索引入口 Z<>: 0宽度字符 E<escape>:字符转义
E<lt>: "<"
E<gt>: ">"
E<verbar>: "|"
E<sol>: "/" 3 资料 perldoc perlpod
I<text>:用斜体表示text
B<text>:用粗体表示text S<text>:包含了非中断的空格的文本 C<code>:表示语法代码 L<name>:表示一个超级链接。用法： L<name>：链接到另一页面 L<name/ident>：链接到页面中的列表条目。 L<name/"sec">：链接到其他页面的区域 L<"sec">：链接到本页的其他区域 F<file>:用于文件名 X<index>:指明索引入口 Z<>: 0宽度字符 E<escape>:字符转义
E<lt>: "<"
E<gt>: ">"
E<verbar>: "|"
E<sol>: "/" 3 资料 perldoc perlpod
相关阅读 更多 +
