Java代碼注釋規(guī)范詳解
代碼附有注釋對(duì)程序開(kāi)發(fā)者來(lái)說(shuō)非常重要，隨著技術(shù)的發(fā)展，在項(xiàng)目開(kāi)發(fā)過(guò)程中，必須要求程序員寫(xiě)好代碼注釋?zhuān)@樣有利于代碼后續(xù)的編寫(xiě)和使用。
基本的要求：
1、注釋形式統(tǒng)一
在整個(gè)應(yīng)用程序中，使用具有一致的標(biāo)點(diǎn)和結(jié)構(gòu)的樣式來(lái)構(gòu)造注釋。如果在其它項(xiàng)目中發(fā)現(xiàn)它們的注釋規(guī)范與這份文檔不同，按照這份規(guī)范寫(xiě)代碼，不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。
2、注釋內(nèi)容準(zhǔn)確簡(jiǎn)潔
內(nèi)容要簡(jiǎn)單、明了、含義準(zhǔn)確，防止注釋的多義性，錯(cuò)誤的注釋不但無(wú)益反而有害。
3、基本注釋?zhuān)ū仨毤樱?/strong>
(a) 類(lèi)（接口）的注釋
(b) 構(gòu)造函數(shù)的注釋
(c) 方法的注釋
(d) 全局變量的注釋
(e) 字段/屬性的注
備注：簡(jiǎn)單的代碼做簡(jiǎn)單注釋?zhuān)⑨寖?nèi)容不大于10個(gè)字即可，另外，持久化對(duì)象或
VO對(duì)象的getter、setter方法不需加注釋。具體的注釋格式請(qǐng)參考下面舉例。
4、特殊必加注釋?zhuān)ū仨毤樱?/strong>
(a) 典型算法必須有注釋。
(b) 在代碼不明晰處必須有注釋。
(c) 在代碼修改處加上修改標(biāo)識(shí)的注釋。
(d) 在循環(huán)和邏輯分支組成的代碼中加注釋。
(e) 為他人提供的接口必須加詳細(xì)注釋。
備注：此類(lèi)注釋格式暫無(wú)舉例。具體的注釋格式自行定義，要求注釋內(nèi)容準(zhǔn)確簡(jiǎn)潔。
5、注釋格式：
1）、單行(single-line)注釋?zhuān)骸?/……”
2）、塊(block)注釋?zhuān)骸?*……*/”
3）、文檔注釋?zhuān)骸?**……*/”
4）、javadoc注釋標(biāo)簽語(yǔ)法
@author 對(duì)類(lèi)的說(shuō)明 標(biāo)明開(kāi)發(fā)該類(lèi)模塊的作者
@version 對(duì)類(lèi)的說(shuō)明 標(biāo)明該類(lèi)模塊的版本
@see 對(duì)類(lèi)、屬性、方法的說(shuō)明 參考轉(zhuǎn)向，也就是相關(guān)主題
@param 對(duì)方法的說(shuō)明 對(duì)方法中某參數(shù)的說(shuō)明
@return 對(duì)方法的說(shuō)明 對(duì)方法返回值的說(shuō)明
@exception 對(duì)方法的說(shuō)明 對(duì)方法可能拋出的異常進(jìn)行說(shuō)明
6、例子：
/**
建立一個(gè)用于操作數(shù)組的工具類(lèi)，其中包含這常見(jiàn)的對(duì)數(shù)組的操作的函數(shù):最值。
@author 張三
@version v.
*/
public class ArrayTool{
/**
獲取整形數(shù)組的最大值
@param arr 接收一個(gè)元素為int類(lèi)型的數(shù)組
@return 該數(shù)組的最大的元素值
*/
public int getMax(int arr){
int Max = ;
return Max;
}
}
輸入命令如下圖：
然后在如下的目錄下查看，最后點(diǎn)擊 index.html：
以上內(nèi)容給大家分享了Java代碼注釋規(guī)范，希望對(duì)大家有所幫助。
相關(guān)文章
這篇文章主要給大家介紹了關(guān)于Java單例模式推薦的兩種模式，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家學(xué)習(xí)或者使用Java具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-06-06
Java進(jìn)行Appium自動(dòng)化測(cè)試的實(shí)現(xiàn)
這篇文章主要介紹了Java進(jìn)行Appium自動(dòng)化測(cè)試的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-01-01
這篇文章介紹了Java匿名內(nèi)部類(lèi)的實(shí)現(xiàn)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2021-12-12
基于Java Springboot + Vue + MyBatis實(shí)現(xiàn)音樂(lè)播放系統(tǒng)
這篇文章主要介紹了一個(gè)完整的音樂(lè)播放系統(tǒng)是基于Java Springboot + Vue + MyBatis編寫(xiě)的，本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2021-08-08
java開(kāi)源區(qū)塊鏈jdchain入門(mén)
這篇文章主要介紹了java開(kāi)源區(qū)塊鏈jdchain入門(mén)，文中為大家講解了關(guān)于部署及組件遇到的一些問(wèn)題，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步2022-02-02
SpringBoot @ConfigurationProperties注解的簡(jiǎn)單使用
即便現(xiàn)在簡(jiǎn)化了配置，但是一個(gè)獨(dú)立的配置文件總是易于理解而且使人安心的。Spring在構(gòu)建完項(xiàng)目后，會(huì)默認(rèn)在resources文件夾下創(chuàng)建一個(gè)application.properties文件，application.yml也是一樣的效果。@ConfigurationProperties可以獲取配置文件中的數(shù)據(jù)，將其注入類(lèi)。2021-05-05
SpringBoot使用Shiro實(shí)現(xiàn)動(dòng)態(tài)加載權(quán)限詳解流程
本文小編將基于?SpringBoot?集成?Shiro?實(shí)現(xiàn)動(dòng)態(tài)uri權(quán)限，由前端vue在頁(yè)面配置uri，Java后端動(dòng)態(tài)刷新權(quán)限，不用重啟項(xiàng)目，以及在頁(yè)面分配給用戶(hù)?角色?、?按鈕?、uri?權(quán)限后，后端動(dòng)態(tài)分配權(quán)限，用戶(hù)無(wú)需在頁(yè)面重新登錄才能獲取最新權(quán)限，一切權(quán)限動(dòng)態(tài)加載，靈活配置2022-07-07
這篇文章主要介紹了Java eclipse doc文檔生成流程解析,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-12-12
Spring 框架 4 支持 Java 8 語(yǔ)言和 API 功能。在本文中，我們將重點(diǎn)放在 Spring 4 支持新的 Java 8 的功能。最重要的是 Lambda 表達(dá)式，方法引用，JSR-310的日期和時(shí)間，和可重復(fù)注釋。下面跟著小編一起來(lái)看下吧2017-03-03
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)建造者模式Builder Pattern，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2021-09-09