文件化開發注釋規範目錄
原則文件化標籤
基礎標籤命令
py常用命令
py文獻資訊
py狀態資訊
py模組資訊
py函式資訊
py提醒資訊
py關聯資訊
py標籤格式
py注釋風格
dox常用命令
dox文獻資訊
dox狀態資訊
dox模組資訊
dox函式資訊
dox提醒資訊
dox關聯資訊
dox標籤格式
dox注釋風格
輸出美化控制
塊結構段落
列表章節
第 1 章
章節 1.1
第 2 章
引用塊行內修飾
特殊標籤
urls
交叉引用
警告塊結構
段落列表
章節引用塊
行內修飾
@b@c
@n特殊標籤
php**說明專用
php章節內容專用
警告反饋
注釋說明必要的資訊，我們不期望精彩的**在注釋中誕生!
適當的設計思路描述
適當的演算法設計描述
epydoc
epydoc注釋規範
doxygen注釋規範
epydoc 解析支援的標籤規範
目錄py常用命令
py文獻資訊
py狀態資訊
py模組資訊
py函式資訊
py提醒資訊
py關聯資訊
py標籤格式
py注釋風格
講述基本的常用標籤命令
@author:...
作者@license:...
版權@contact:...聯絡
@version:...
版本推薦使用$id$
@todo[ver]: ...
改進,可以指定針對的版本
@varv: ...
模組變數v 說明
@typev: ...
模組變數型別v 說明
@paramp: ...
引數 p 說明
@typev: ...
引數 p 型別說明
@return: ...
返回值說明
@rtype: ...
返回值型別說明
@note:...
註解@attention:...
注意@bug:...
問題@warning:...警告
@see:...
參考資料
約定文件化標籤的語法
約定文件化標籤放置
-- zoomquiet (2005-01-26)
Swift 文件注釋規範
的結構和組織關乎了開發童鞋們的節操問題。明確和一致的 表示了明確和一貫的思想。編譯器並沒有乙個挑剔的口味，但當談到命名，空格或文件，人類的差異就體現出來了。nshipster 的讀者無疑會記得去年發表的關於文件的文章，但很多東西已經在 xcode 6 中發生了變化 幸運的是，基本上算是變得更好了 因...
PHP之文件注釋規範PHPDoc
良好的文件注釋不但能使 易於維護，而且可以通過phpdocumentor等文件生成工具生成專案手冊，以便於查閱。此外php的弱型別特徵更應該引起我們對文件注釋的重視！本文簡單的介紹下phpdoc文件注釋，以及常用的一些標籤。1.文件注釋並不只是用來注釋整個檔案的，在元素前面宣告之後，它可以和該特定的...
效能優化 開發規範和優化 細節
sql 1.sql顯示內連線代替隱式內連線 2.sql引數查詢，sql函式不要作用於列，把引數格式化去匹配，3.sql查詢避免用 號，用具體的列表示，籠統，模糊的概念不利於程式閱讀，維護，具體化，細節化。4.mybatis介面引數少於5個，不用物件類，1.一方面介面引數一目了然，方面別人復用 2.減...