Perl POD 文檔

Perl POD 文檔

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

POD 是一種簡(jiǎn)單而易用的標(biāo)記型語(yǔ)言(置標(biāo)語(yǔ)言)项阴。

POD 文檔使用規(guī)則:

POD 文檔以 =head1 開(kāi)始糯景, =cut 結(jié)束, =head1 前與 =cut 后添加一空行。

Perl 會(huì)忽略 POD 中的文檔。實(shí)例如下:

實(shí)例

#!/usr/bin/perl
 
print "Hello, World\n";
 
=head1 Hello, World 實(shí)例
這是一個(gè) Perl 的簡(jiǎn)單實(shí)例。
=cut
 
print "Hello, Runoob\n";

執(zhí)行以上程序锈麸,輸出結(jié)果為:

Hello, World
Hello, Runoob

我們還可以使用 "END" 或 "DATA" 將所在行之后的內(nèi)容全部"注釋"掉:

實(shí)例

#!/usr/bin/perl
 
print "Hello, World\n";
 
while(<DATA>){
  print $_;
}
 
__END__
 
=head1 Hello, World 實(shí)例
這是一個(gè) Perl 的簡(jiǎn)單實(shí)例。
print "Hello, Runoob\n";

執(zhí)行以上程序牺蹄,輸出結(jié)果為:

Hello, World

=head1 Hello, World 實(shí)例
這是一個(gè) Perl 的簡(jiǎn)單實(shí)例忘伞。
print "Hello, Runoob\n";

以下實(shí)例不讀取 POD 文檔:

實(shí)例

#!/usr/bin/perl
 
print "Hello, World\n";
 
__END__
 
=head1 Hello, World 實(shí)例
這是一個(gè) Perl 的簡(jiǎn)單實(shí)例。
print "Hello, Runoob\n";

執(zhí)行以上程序沙兰,輸出結(jié)果為:

Hello, World

什么是 POD氓奈?

Pod(Plain Old Documentation), 是一種簡(jiǎn)單而易用的標(biāo)記型語(yǔ)言(置標(biāo)語(yǔ)言),它經(jīng)常用于在perl程序和模塊中的文檔書(shū)寫(xiě)鼎天。

Pod 的 轉(zhuǎn)化器可以將 Pod 轉(zhuǎn)換成很多種格式舀奶,例如 text, html, man 等很多。

Pod 標(biāo)記語(yǔ)言包含三種基本基本類型: 普通, 原文, 和 命令斋射。

  • 普通段落: 你可以在普通段落中使用格式化代碼育勺,如黑體,斜體罗岖,或代碼風(fēng)格涧至,下劃線等。

  • 原文段落: 原文段落桑包,用于代碼塊或者其他不需要轉(zhuǎn)換器處理的部分南蓬,而且不需要段落重排。

  • 命令段落: 命令段落作用于整個(gè)的文檔哑了,通常用于標(biāo)題設(shè)置或列表標(biāo)記赘方。

    所有的命令段落(他只有一行的長(zhǎng)度)使用 "=" 開(kāi)始,然后是一個(gè)標(biāo)識(shí)符弱左。 隨后的文本將被這條命令所影響≌福現(xiàn)在被廣泛使用的命令包括

    =pod (開(kāi)始文檔)
    =head1 標(biāo)題文本
    =head2 標(biāo)題文本
    =head3 標(biāo)題文本
    =head4 標(biāo)題文本
    =over 縮進(jìn)空格數(shù)量
    =item 前綴
    =back (結(jié)束列表)
    =begin 文檔格式
    =end 結(jié)束文檔格式
    =for 格式文本
    =encoding 編碼類型
    =cut (文檔結(jié)束)
    

在perl中,可以使用 pod2html .pod >.html 來(lái)生成html格式的pod文檔拆火。

考慮以下 POD 實(shí)例:

實(shí)例

=begin html
=encoding utf-8
 
=head1 菜鳥(niǎo)教程
 
=cut

pod2html時(shí)會(huì)原文拷貝此段代碼跳夭。

使用 pod2html 命令執(zhí)行鳖悠,將其轉(zhuǎn)換為 HTML 代碼:

$ pod2html test.pod > test.html 

在瀏覽器中打開(kāi) test.html,鏈接部分為索引优妙,顯示如下:

img

以下實(shí)例在 POD 文檔中直接寫(xiě)入 HTML:

=begin html
=encoding utf-8

<h1>菜鳥(niǎo)教程</h1>
<p> www.runoob.com </p>

=end html

pod2html時(shí)會(huì)原文拷貝此段代碼。

使用 pod2html 命令執(zhí)行憎账,將其轉(zhuǎn)換為 HTML 代碼:

$ pod2html test.pod > test.html 

在瀏覽器中打開(kāi) test.html套硼,鏈接部分為索引,顯示如下:

img
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末胞皱,一起剝皮案震驚了整個(gè)濱河市邪意,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌反砌,老刑警劉巖雾鬼,帶你破解...
    沈念sama閱讀 216,402評(píng)論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異宴树,居然都是意外死亡策菜,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)酒贬,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)又憨,“玉大人,你說(shuō)我怎么就攤上這事锭吨〈垒海” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,483評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵零如,是天一觀的道長(zhǎng)躏将。 經(jīng)常有香客問(wèn)我,道長(zhǎng)考蕾,這世上最難降的妖魔是什么祸憋? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,165評(píng)論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮辕翰,結(jié)果婚禮上夺衍,老公的妹妹穿的比我還像新娘。我一直安慰自己喜命,他們只是感情好沟沙,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,176評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著壁榕,像睡著了一般矛紫。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上牌里,一...
    開(kāi)封第一講書(shū)人閱讀 51,146評(píng)論 1 297
  • 那天颊咬,我揣著相機(jī)與錄音务甥,去河邊找鬼。 笑死喳篇,一個(gè)胖子當(dāng)著我的面吹牛敞临,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播麸澜,決...
    沈念sama閱讀 40,032評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼挺尿,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了炊邦?” 一聲冷哼從身側(cè)響起编矾,我...
    開(kāi)封第一講書(shū)人閱讀 38,896評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎馁害,沒(méi)想到半個(gè)月后窄俏,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,311評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡碘菜,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,536評(píng)論 2 332
  • 正文 我和宋清朗相戀三年凹蜈,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片忍啸。...
    茶點(diǎn)故事閱讀 39,696評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡踪区,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出吊骤,到底是詐尸還是另有隱情缎岗,我是刑警寧澤,帶...
    沈念sama閱讀 35,413評(píng)論 5 343
  • 正文 年R本政府宣布白粉,位于F島的核電站传泊,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏鸭巴。R本人自食惡果不足惜眷细,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,008評(píng)論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望鹃祖。 院中可真熱鬧溪椎,春花似錦、人聲如沸恬口。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)祖能。三九已至歉秫,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間养铸,已是汗流浹背雁芙。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,815評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工轧膘, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人兔甘。 一個(gè)月前我還...
    沈念sama閱讀 47,698評(píng)論 2 368
  • 正文 我出身青樓谎碍,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親洞焙。 傳聞我的和親對(duì)象是個(gè)殘疾皇子椿浓,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,592評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容

  • 之前因?yàn)檎n程所需,自然而然的需要接觸此作品提岔,但因?yàn)槠淦^長(zhǎng)仙蛉,再加上自己心浮氣躁,每每都是從網(wǎng)上尋找資料碱蒙,進(jìn)行片段...
    愛(ài)畫(huà)愛(ài)寫(xiě)的鯤閱讀 611評(píng)論 0 12
  • 今天的天氣特別得好荠瘪,有燦爛的太陽(yáng),倒映著波瀾壯闊的大海赛惩,真像是一幅美麗的畫(huà)卷哀墓,漁船們?cè)诤I闲旭傊o這幅美...
    我自己喜歡的事活著閱讀 366評(píng)論 0 0
  • 自我激勵(lì)喷兼,也就是自打雞血篮绰。我聽(tīng)過(guò)一句俗語(yǔ),就是自己選擇的路季惯,跪著也要走完吠各。這也是自我激勵(lì)。 外界的獎(jiǎng)勵(lì)或者懲罰等激...
    lwch閱讀 277評(píng)論 0 3