Perl 中可以在模組或腳本中嵌入POD(Plain Old Documentation) 文件。
POD 是一種簡單而易用的標記型語言(置標語言)。
POD 文件使用規則:
POD 文件以=head1開始, =cut結束, =head1前與=cut後新增一空行。
Perl 會忽略POD 中的文件。實例如下:
執行以上程序,輸出結果為:
Hello, WorldHello, Codercto
我們也可以使用"__END__" 或"__DATA__" 將所在行之後的內容全部"註解"掉:
執行以上程序,輸出結果為:
Hello, World=head1 Hello, World 實例這是一個Perl 的簡單實例。 print "Hello, Codercton";
以下實例不讀取POD 文件:
執行以上程序,輸出結果為:
Hello, World
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 實例:
pod2html時會原文拷貝此段代碼。
使用pod2html 指令執行,將其轉換為HTML 程式碼:
$ pod2html test.pod > test.html
在瀏覽器中開啟test.html,連結部分為索引,顯示如下:
以下實例在POD 文件中直接寫入HTML:
=begin html=encoding utf-8<h1>碼農教學</h1><p> www.codercto.com </p>=end html
pod2html時會原文拷貝此段代碼。
使用pod2html 指令執行,將其轉換為HTML 程式碼:
$ pod2html test.pod > test.html
在瀏覽器中開啟test.html,連結部分為索引,顯示如下: