Perl 最佳實務(節選) --- 07

來源:互聯網
上載者:User

標籤:

第七章:說明文檔 零捌肆.

區分使用者說明文檔和技術說明文檔。 零捌伍.

替模組和應用程式建立標準POD模板。 零捌陸.

把你的標準POD模板予以擴充和自訂。 零捌柒.

在原始碼檔案中放置使用者說明文檔。 零捌捌.

把所有使用者說明文檔放在原始碼檔案中的單獨的地方。 零捌玖.

儘可能把POD放在靠近檔案末尾處。 零捌肆.

對技術說明文檔做適當的細化。 零玖零.

主要注釋應使用塊模板。 零玖壹.

使用整行注釋來說明演算法。 零玖貳.

使用行章節附註釋來指出微妙之處和奇怪之處。 零玖三.

對任何讓你困惑或受騙的東西都要做注釋。 零玖肆.

考慮改寫是否比做注釋更好。 零玖伍.

較長的技術討論內容要使用“看不見”的POD段落。 零玖陸.

檢查說明文檔的拼字、文法以及健全性。

Perl 最佳實務(節選) --- 07

相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在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.