Perl 中 Pod 的基本用法。


1. Pod 語法

pod中用段分可以分為三種,普通段落,字面段落(Verbatim Paragraph)和命令段落。
三者的區分非常簡單,以=pod|head1|cut|over等指示字開始的段落為命令段落,以空格或制表符(\t)等縮進開始的段落為字面段落,其余的就是普通段落。

 

[php]  view plain  copy
 
  1. =head1  
  2. =head2  
  3. =head3  
  4. =head4  
  5. 此四個指示字生產指定級別的標題。pod2html時用其對應的<h1> .. </h4>包圍此段落,並且自動生成a的命名/name和索引/index.  

 

[plain]  view plain  copy
 
  1. =pod  
  2. =cut  
  3. =pod 只告訴編譯器pod文檔開始了,而=cut則是pod文檔的結束。  

 

[plain]  view plain  copy
 
  1. =over NUMBER         縮近多少  
  2. =item SYMBOL         產生bullet  
  3. =back  
  4. 這三者是連上一起的。=over后面必須要跟一個=back,而這兩者之間最少要有一個=item,同時不能有=head1..4。  

 

[plain]  view plain  copy
 
  1. 格式代碼  
  2.   
  3. 格式代碼可以用於除字面段落外的所有段落,包括命令段落。  
  4. I<text>  
  5. 用斜體表示text, 效果如text  
  6. B<text>  
  7. 用粗體表示text, 效果如text  
  8. C<code>  
  9. pod2html時用<code>包圍。  
  10. L<text|name/sec>  
  11. 超鏈接。  

 

 

2. pod2usage 在package中的使用。

    如果想顯示 perl module中的pod,那么采用如下

 

[plain]  view plain  copy
 
  1. use Pod::Find qw(pod_where);  
  2. pod2usage( -input => pod_where({-inc => 1}, __PACKAGE__) );  
  3. 其中:-inc=>1  表示 Search @INC for the pod and also the scriptdir   __PACKAGE__ 表示包文件,如果是A::B 則表示  A/B  
  4.  pod_where 返回 文件句柄的引用, pod2usage 中default值是 $0, 當前文件而不是包本身  
 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM