1，單行(單行)-簡(jiǎn)短說明: ///...

單行注釋: 代碼中的單行注釋. 最好在注釋前有一個(gè)空行，并在其后加上與代碼相同的縮進(jìn)級(jí)別. 如果無法完成一行，則應(yīng)使用塊注釋.

評(píng)論格式:

在行首注釋: 在代碼行首注釋. 主要是使代碼行毫無意義.

評(píng)論格式: //評(píng)論內(nèi)容

在行尾注釋: 尾隨-在代碼行末尾非常簡(jiǎn)短的注釋. 通常在代碼行后8個(gè)(至少4個(gè))空格，所有注釋必須對(duì)齊.

評(píng)論格式: 代碼+ 8個(gè)(至少4個(gè))空格+ //評(píng)論內(nèi)容

2. 阻止-阻止評(píng)論:

注釋幾行，通常用于提供文件，方法，數(shù)據(jù)結(jié)構(gòu)等的含義和目的的描述，或算法的描述. 通常位于文件或方法的前面，它起著指導(dǎo)作用，也可以根據(jù)需要放置在合適的位置. 此域注釋不會(huì)出現(xiàn)在HTML報(bào)告中. 注釋格式通常寫為:

3. 文件注釋:

注釋幾行并寫入javadoc文檔. 每個(gè)文檔注釋都將放置在注釋定界符中

其中，注釋文檔將用于生成HTML格式的代碼報(bào)告，因此注釋文本

The

文件必須在定義類，字段，構(gòu)造函數(shù)，方法和字段之前編寫. 注釋文檔由兩部分組成: 描述和塊標(biāo)記. 批注文檔的格式如下:

公共無效doGet(HttpServletRequest請(qǐng)求，HttpServletResponse響應(yīng))

引發(fā)ServletException，IOException {

doPost(請(qǐng)求，響應(yīng));

}

前兩行的說明. 描述完成后，塊符號(hào)以@符號(hào)開頭. 更多文檔說明

有關(guān)Shihe javadoc的詳細(xì)信息，請(qǐng)參閱javadoc主頁:

4. javadoc注釋標(biāo)記語法

@author對(duì)類的描述表示開發(fā)該模塊的作者

有關(guān)該類的@version的說明表示該類的模塊的版本

通過@see參考轉(zhuǎn)向(即相關(guān)主題)來描述類，屬性和方法

@param對(duì)方法的描述方法中的參數(shù)說明

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

@exception對(duì)方法的說明解釋該方法可能引發(fā)的異常

六. JAVA注釋的實(shí)現(xiàn)

1，源文件注釋

注釋源文件，并且在每個(gè)源文件的開頭都需要必要的注釋信息，包括: 文件名；文件編號(hào);版本號(hào)；作者;創(chuàng)建時(shí)間；文件描述，包括此文件的歷史記錄修改記錄. 中文注釋模板:

2. 類(模塊)注釋:

使用類(模塊)注釋. 在每個(gè)類(模塊)的開頭，必須包括必要的注釋信息，包括: 項(xiàng)目名稱；類(模塊)號(hào)；命名空間該類可以運(yùn)行的JDK版本；版本號(hào);作者;創(chuàng)建時(shí)間；類(模塊)的功能描述(例如功能，主要算法，內(nèi)部部件之間的關(guān)系，此類與其類之間的關(guān)系等)，必要時(shí)必須有一些特殊的軟硬件要求等說明；此類(模塊)的主要功能或過程列表以及歷史修改記錄.

英語注釋模板:

如果模塊僅修改少量代碼，則每次修改都必須添加以釋:

//重寫器

//重寫日期: 開始1:

// End1:

注釋掉原始代碼的內(nèi)容，然后使用以釋添加新代碼:

//添加人

//添加日期: jsp代碼注釋，格式: YYYY-MM-DD>開始2:

// End2:

如果模塊的輸入和輸出參數(shù)或功能結(jié)構(gòu)有重大修改，則每次修改都必須添加以下內(nèi)容

評(píng)論:

//日志ID:

//描述:

//作家: 修飾語的中文名稱

//重寫日期:

2. 界面說明:

使用接口注釋. 基于令人滿意的類批注，接口批注應(yīng)包含有關(guān)接口用途，應(yīng)如何使用以及不應(yīng)如何使用的描述. 方框標(biāo)記必須指明作者和版本. 在清除接口注釋的前提下，可以不注釋相應(yīng)的實(shí)現(xiàn)類.

3. 構(gòu)造說明:

構(gòu)造函數(shù)注釋使用，描述部分指示構(gòu)造函數(shù)的作用，并且不一定有塊標(biāo)記.

注釋模板1:

評(píng)論模板二:

4. 功能說明:

使用功能注釋. 在每個(gè)功能或過程之前，必須有必要的注釋信息，包括: 功能或過程名稱；功能說明;輸入，輸出和返回值說明；調(diào)用關(guān)系和被調(diào)用關(guān)系描述等. 版本號(hào)(@version)可能不會(huì)出現(xiàn)在函數(shù)注釋中.

注釋模板1:

評(píng)論模板二:

5. 方法說明:

采用方法注釋. 對(duì)于設(shè)置(Set方法)和獲取(Get方法)成員的方法，在解釋了成員變量后，不能添加任何注釋；需要普通的成員方法來說明完成了什么功能，參數(shù)的含義是什么，返回值是什么；此外，必須清楚說明該方法的創(chuàng)建時(shí)間，以為將來的維護(hù)和閱讀提供有價(jià)值的線索.

6. 該方法的內(nèi)部注釋:

控制結(jié)構(gòu)，代碼的功能以及執(zhí)行的原因，處理順序等. 尤其對(duì)于復(fù)雜的邏輯處理部分，應(yīng)盡可能給出詳細(xì)的注釋.

7. 全局變量注釋:

更詳細(xì)的注釋，包括對(duì)其功能，值范圍，訪問的功能或過程的說明，以及訪問期間的注意事項(xiàng)等.

8. 局部(中間)變量注釋:

必須對(duì)主要變量進(jìn)行注釋，如果沒有特殊含義jsp代碼注釋，可以不加注釋.

9. 實(shí)際參數(shù)/參數(shù)說明:

參數(shù)含義以及任何其他約束或前提條件.

10. 字段/屬性注釋: 字段描述，屬性描述.

11. 常量: 常量通常具有一定的實(shí)際意義，必須定義相應(yīng)的描述.

本文來自電腦雜談，轉(zhuǎn)載請(qǐng)注明本文網(wǎng)址：

http://www.pc-fly.com/a/jisuanjixue/article-254359-1.html

總結(jié)

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

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