|
1. Pod 语法
pod中用段分可以分为三种，普通段落，字面段落（Verbatim Paragraph）和命令段落。
三者的区分非常简单，以=pod|head1|cut|over等指示字开始的段落为命令段落，以空格或制表符（\t）等缩进开始的段落为字面段落，其余的就是普通段落。
- =head1
- =head2
- =head3
- =head4
- 此四个指示字生产指定级别的标题。pod2html时用其对应的<h1> .. </h4>包围此段落，并且自动生成a的命名/name和索引/index.
- =pod
- =cut
- =pod 只告诉编译器pod文档开始了，而=cut则是pod文档的结束。
- =over NUMBER 缩近多少
- =item SYMBOL 产生bullet
- =back
- 这三者是连上一起的。=over后面必须要跟一个=back，而这两者之间最少要有一个=item，同时不能有=head1..4。
- 格式代码
-
- 格式代码可以用于除字面段落外的所有段落，包括命令段落。
- I<text>
- 用斜体表示text, 效果如text
- B<text>
- 用粗体表示text, 效果如text
- C<code>
- pod2html时用<code>包围。
- L<text|name/sec>
- 超链接。
2. pod2usage 在package中的使用。
如果想显示 perl module中的pod，那么采用如下
- use Pod::Find qw(pod_where);
- pod2usage( -input => pod_where({-inc => 1}, __PACKAGE__) );
- 其中：-inc=>1 表示 Search @INC for the pod and also the scriptdir __PACKAGE__ 表示包文件，如果是A::B 则表示 A/B
- pod_where 返回 文件句柄的引用， pod2usage 中default值是 $0, 当前文件而不是包本身
|
客服电话
APP下载
官方微信
请发表评论