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