Perl POD 文檔

知識 02-26

Perl 中可以在模塊或腳本中嵌入 POD（Plain Old Documentation）文檔。

POD 是一種簡單而易用的標記型語言（置標語言）。

POD 文檔使用規則：

POD 文檔以 =head1 開始， =cut 結束， =head1 前與 =cut 後添加一空行。

Perl 會忽略 POD 中的文檔。實例如下：

實例

#!/usr/bin/perlprint"Hello, World
";
=head1 Hello, World 實例
這是一個 Perl 的簡單實例。=cutprint"Hello, Runoob
";

執行以上程序，輸出結果為：

Hello, WorldHello, Runoob

我們還可以使用 "__END__" 或 "__DATA__" 將所在行之後的內容全部"注釋"掉：

實例

#!/usr/bin/perlprint"Hello, World
";
while(<DATA>){print$_;}__END__=head1 Hello, World 實例
這是一個 Perl 的簡單實例。
print "Hello, Runoob
";

執行以上程序，輸出結果為：

Hello, World=head1 Hello, World 實例這是一個 Perl 的簡單實例。print "Hello, Runoob
";

以下實例不讀取 POD 文檔：

實例

#!/usr/bin/perlprint"Hello, World
";
__END__=head1 Hello, World 實例
這是一個 Perl 的簡單實例。
print "Hello, Runoob
";

執行以上程序，輸出結果為：

Hello, World

Perl POD 文檔

什麼是 POD？

Pod(Plain Old Documentation), 是一種簡單而易用的標記型語言（置標語言），它經常用於在perl程序和模塊中的文檔書寫。

Pod 的轉化器可以將 Pod 轉換成很多種格式，例如 text, html, man 等很多。

Pod 標記語言包含三種基本基本類型：普通, 原文, 和命令。

普通段落: 你可以在普通段落中使用格式化代碼，如黑體，斜體，或代碼風格，下劃線等。
原文段落: 原文段落，用於代碼塊或者其他不需要轉換器處理的部分，而且不需要段落重排。
命令段落: 命令段落作用於整個的文檔，通常用於標題設置或列表標記。
所有的命令段落（他只有一行的長度）使用 "=" 開始，然後是一個標識符。隨後的文本將被這條命令所影響。現在被廣泛使用的命令包括
=pod (開始文檔)=head1 標題文本=head2 標題文本=head3 標題文本=head4 標題文本=over 縮進空格數量=item 前綴=back (結束列表)=begin 文檔格式=end 結束文檔格式=for 格式文本=encoding 編碼類型=cut (文檔結束)

在perl中，可以使用 pod2html **.pod >**.html 來生成html格式的pod文檔。

考慮以下 POD 實例：

實例

=begin html
=encoding utf-8

=head1 菜鳥教程
=cut

pod2html時會原文拷貝此段代碼。

使用 pod2html 命令執行，將其轉換為 HTML 代碼：

$ pod2html test.pod > test.html

在瀏覽器中打開 test.html，鏈接部分為索引，顯示如下:

以下實例在 POD 文檔中直接寫入 HTML:

=begin html=encoding utf-8<h1>菜鳥教程</h1><p> www.runoob.com </p>=end html

pod2html時會原文拷貝此段代碼。