前言：
最近完成了大創的程式編寫，想放到網上，但一堆**想來質量高不了，但好歹希望別人能看懂，這裡學習一下注釋規範，回去整理**
基本注釋：
備註1：持久化物件或vo物件的getter、setter方法不需加注釋。
備註2：複雜功能也應該寫在相應部分寫好注釋
(a) 類（介面）的注釋。是簡單的功能介紹。
/**
* 類的描述
*@author administrator
*@time 2012-11-2014:49:01
*/
/**
* 構造方法 的描述
*@param name
* 按鈕的上顯示的文字
*/
/**
* 〈一句話功能簡述〉
* 〈功能詳細描述〉
*@param [引數1] [in或out] [引數1說明]
*@param [引數2] [in或out] [引數2說明]
*@return [返回型別說明]
*@exception/throws [違例型別] [違例說明]
*/
/** the value is used for characterstorage. */
private
final
char value;
private
int count;//浴室人數
Java和Android注釋規範
1 檔案頭注釋 每乙個檔案的檔案頭都必須做檔案頭注釋。檔案頭注釋範例如下 檔名 loginactivity 描 述 對使用者 作 者 時 間 版 權 2 方法頭注釋 每乙個成員方法 包括自定義成員方法 覆蓋方法 屬性方法 的方法頭都必須做方法頭注釋。自定義成員方法注釋範例如下 方法名 login c...
規範 前端編碼規範 注釋規範
頂部新增檔案申明資訊，包括檔案描述 原始作者，如果有更新，則需要新增更新內容 更新作者和更新時間。description 說明文字 author 張三 description 說明文字 author 張三 update 更新內容 by 李四 2013 04 13 18 32 無論是單行注釋還是多行注...
C 注釋規範
5.注釋 5.1.注釋的基本約定 注釋應該增加 的清晰度 保持注釋的簡潔，不是任何 都需要注釋的，過多的注釋反而會影響 的可讀性。注釋不要包括其他的特殊字元。建議先寫注釋，後寫 注釋和 一起完成 如果語句塊 比如迴圈和條件分枝的 塊 太長，巢狀太多，則在其結束 要加上注釋，標誌對應的開始語句。如果分...