快捷導(dǎo)航

Java代碼注釋規(guī)范詳解

更新時(shí)間：2016年02月03日 11:53:53 作者：楊鑫newlfe

代碼附有注釋對(duì)程序開發(fā)者來說非常重要，隨著技術(shù)的發(fā)展，在項(xiàng)目開發(fā)過程中，必須要求程序員寫好代碼注釋，這樣有利于代碼后續(xù)的編寫和使用。下面給大家分享java代碼注釋的規(guī)范，需要的朋友參考下

代碼附有注釋對(duì)程序開發(fā)者來說非常重要，隨著技術(shù)的發(fā)展，在項(xiàng)目開發(fā)過程中，必須要求程序員寫好代碼注釋，這樣有利于代碼后續(xù)的編寫和使用。

基本的要求：

1、注釋形式統(tǒng)一

在整個(gè)應(yīng)用程序中，使用具有一致的標(biāo)點(diǎn)和結(jié)構(gòu)的樣式來構(gòu)造注釋。如果在其它項(xiàng)目中發(fā)現(xiàn)它們的注釋規(guī)范與這份文檔不同，按照這份規(guī)范寫代碼，不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。

2、注釋內(nèi)容準(zhǔn)確簡(jiǎn)潔

內(nèi)容要簡(jiǎn)單、明了、含義準(zhǔn)確，防止注釋的多義性，錯(cuò)誤的注釋不但無益反而有害。

3、基本注釋（必須加）

(a) 類（接口）的注釋
(b) 構(gòu)造函數(shù)的注釋
(c) 方法的注釋
(d) 全局變量的注釋
(e) 字段/屬性的注
備注：簡(jiǎn)單的代碼做簡(jiǎn)單注釋，注釋內(nèi)容不大于10個(gè)字即可，另外，持久化對(duì)象或
VO對(duì)象的getter、setter方法不需加注釋。具體的注釋格式請(qǐng)參考下面舉例。

4、特殊必加注釋（必須加）

(a) 典型算法必須有注釋。
(b) 在代碼不明晰處必須有注釋。
(c) 在代碼修改處加上修改標(biāo)識(shí)的注釋。
(d) 在循環(huán)和邏輯分支組成的代碼中加注釋。
(e) 為他人提供的接口必須加詳細(xì)注釋。

備注：此類注釋格式暫無舉例。具體的注釋格式自行定義，要求注釋內(nèi)容準(zhǔn)確簡(jiǎn)潔。

5、注釋格式：

1）、單行(single-line)注釋：“//……”
2）、塊(block)注釋：“/*……*/”
3）、文檔注釋：“/**……*/”
4）、javadoc注釋標(biāo)簽語法

@author 對(duì)類的說明標(biāo)明開發(fā)該類模塊的作者
@version 對(duì)類的說明標(biāo)明該類模塊的版本
@see 對(duì)類、屬性、方法的說明參考轉(zhuǎn)向，也就是相關(guān)主題
@param 對(duì)方法的說明對(duì)方法中某參數(shù)的說明
@return 對(duì)方法的說明對(duì)方法返回值的說明
@exception 對(duì)方法的說明對(duì)方法可能拋出的異常進(jìn)行說明

6、例子：

/** 
建立一個(gè)用于操作數(shù)組的工具類，其中包含這常見的對(duì)數(shù)組的操作的函數(shù):最值。 
@author 張三 
@version v. 
*/ 
public class ArrayTool{ 

/** 
獲取整形數(shù)組的最大值 
@param arr 接收一個(gè)元素為int類型的數(shù)組 
@return 該數(shù)組的最大的元素值 
*/ 
public int getMax(int arr){ 
int Max = ; 
return Max; 
} 
}

輸入命令如下圖：