從Perl code裡直接產生文檔的方法

來源:互聯網
上載者:User
Perl支援把你的pod格式文字塊產生文檔,這個pod格式文字塊可以是植入在代碼裡的標記語言,也可以是單獨的一個檔案。
有了pod,只要在寫指令碼的時候,隨手記下想法、說明,就不用再另外編寫文檔了,非常方便。
建議先仔細讀一讀perldoc perlpod裡面的內容,文檔詳細介紹了pod標記語言的文法。
$ perldoc perlpod

盡量保證一個比較好的書寫習慣,例如:
=pod
=head1 NAME
Water::Test – The great new Water::Test!
=head1 VERSION
Version 0.01
=cut

開始和結束都應該要空一行。當你用如上形式寫到你的代碼檔案裡後,你只要用pod2html, pod2man之類的命令,就可以把它轉為文檔。
例如,如果你把上面的代碼儲存為test.txt檔案,則用如下命令可以把它轉為html文檔:
$ pod2html –infile test.txt –outfile text.html

相關文章
阿里云产品大规模降价
  • 最高幅度達59%,平均降幅23%
  • 核心產品降價
  • 多地區降價
undefined. /
透過 Discord 與我們聯繫
  • 安全、匿名的群聊,不受干擾
  • 隨時了解活動、活動、新產品等訊息
  • 支持您的所有問題
undefined. /
免費試用
  • 開啟從ECS到大數據的免費試用之旅
  • 只需三步 輕鬆上雲
  • 免費試用ECS t5 1C1G
undefined. /

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.