基本的要求：
1、注釋形式統一
在整個應用程序中，使用具有一致的標點和結構的樣式來構造注釋。如果在其它項目中發現它們的注釋規范與這份文檔不同，按照這份規范寫代碼，不要試圖在既成的規范系統中引入新的規范。
2、注釋內容准確簡潔
內容要簡單、明了、含義准確，防止注釋的多義性，錯誤的注釋不但無益反而有害。
3、基本注釋（必須加）
(a) 類（接口）的注釋
(b) 構造函數的注釋
(c) 方法的注釋
(d) 全局變量的注釋
(e) 字段/屬性的注
備注：簡單的代碼做簡單注釋，注釋內容不大於10個字即可，另外，持久化對象或
VO對象的getter、setter方法不需加注釋。具體的注釋格式請參考下面舉例。
4、特殊必加注釋（必須加）
(a) 典型算法必須有注釋。
(b) 在代碼不明晰處必須有注釋。
(c) 在代碼修改處加上修改標識的注釋。
(d) 在循環和邏輯分支組成的代碼中加注釋。
(e) 為他人提供的接口必須加詳細注釋。
備注：此類注釋格式暫無舉例。具體的注釋格式自行定義，要求注釋內容准確簡潔。
5、注釋格式：
1）、單行(single-line)注釋：“//……”
2）、塊(block)注釋：“/*……*/”
3）、文檔注釋：“/**……*/”
4）、javadoc注釋標簽語法
@author 對類的說明 標明開發該類模塊的作者
@version 對類的說明 標明該類模塊的版本
@see 對類、屬性、方法的說明 參考轉向，也就是相關主題
@param 對方法的說明 對方法中某參數的說明
@return 對方法的說明 對方法返回值的說明
@exception 對方法的說明 對方法可能拋出的異常進行說明
1 /** 2 建立一個用於操作數組的工具類，其中包含這常見的對數組的操作的函數:最值。 3 @author 張三 4 @version v. 5 */ 6 public class ArrayTool{ 7 8 /** 9 獲取整形數組的最大值 10 @param arr 接收一個元素為int類型的數組 11 @return 該數組的最大的元素值 12 */ 13 public int getMax(int arr){ 14 int Max = ; 15 return Max; 16 } 17 }