基本的要求：

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

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

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

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

3、基本注釋(必須加)

(a) 類(接口)的注釋

(b) 構(gòu)造函數(shù)的注釋

(c) 方法的注釋

(d) 全局變量的注釋

(e) 字段/屬性的注

備注：簡單的代碼做簡單注釋，注釋內(nèi)容不大于10個字即可，另外，持久化對象或

VO對象的getter、setter方法不需加注釋。具體的注釋格式請參考下面舉例。

4、特殊必加注釋(必須加)

(a) 典型算法必須有注釋。

(b) 在代碼不明晰處必須有注釋。

(c) 在代碼修改處加上修改標(biāo)識的注釋。

(d) 在循環(huán)和邏輯分支組成的代碼中加注釋。

(e) 為他人提供的接口必須加詳細(xì)注釋。

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

5、注釋格式：

1)、單行(single-line)注釋：“//……”

2)、塊(block)注釋：“/*……*/”

3)、文檔注釋：“/**……*/”

4)、javadoc注釋標(biāo)簽語法

@author 對類的說明 標(biāo)明開發(fā)該類模塊的作者

@version 對類的說明 標(biāo)明該類模塊的版本

@see 對類、屬性、方法的說明 參考轉(zhuǎn)向，也就是相關(guān)主題

@param 對方法的說明 對方法中某參數(shù)的說明

@return 對方法的說明 對方法返回值的說明

@exception 對方法的說明 對方法可能拋出的異常進(jìn)行說明

1 /**

2 建立一個用于操作數(shù)組的工具類，其中包含這常見的對數(shù)組的操作的函數(shù):最值。3 @author張三4 @versionv.5 */

6 public classArrayTool{7

8 /**

9 獲取整形數(shù)組的最大值10 @paramarr 接收一個元素為int類型的數(shù)組11 @return該數(shù)組的最大的元素值12 */

13 public int getMax(intarr){14 int Max =;15 returnMax;16 }17 }

總結(jié)

以上是生活随笔為你收集整理的java的注释规范_Java 注释规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。