Java代碼注釋規範詳解_java

代碼附有注釋對程式開發人員來說非常重要，隨著技術的發展，在項目開發過程中，必須要求程式員寫好代碼注釋，這樣有利於代碼後續的編寫和使用。

基本的要求：

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 對方法的說明 對方法可能拋出的異常進行說明

6、例子：

/** 建立一個用於運算元組的工具類，其中包含這常見的對數組的操作的函數:最值。 @author 張三 @version v. */ public class ArrayTool{ /** 擷取整形數組的最大值 @param arr 接收一個元素為int類型的數組 @return 該數組的最大的元素值 */ public int getMax(int arr){ int Max = ; return Max; } } 

輸入命令如下圖：

然後在如下的目錄下查看，最後點擊 index.html：

以上內容給大家分享了Java代碼注釋規範，希望對大家有所協助。