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

代碼附有注釋對程序開發(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)確簡潔

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

3、基本注釋(必須加)

(a) 類(接口)的注釋

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

(c) 方法的注釋

(d) 全局變量的注釋

(e) 字段/屬性的注

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

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)行說明

6、例子：

/**

建立一個(gè)用于操作數(shù)組的工具類，其中包含這常見的對數(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;

}

}

輸入命令如下圖：

然后在如下的目錄下查看，最后點(diǎn)擊 index.html：

以上內(nèi)容給大家分享了Java代碼注釋規(guī)范，希望對大家有所幫助。相關(guān)閱讀:

js onload處理html頁面加載之后的事件

讓Centos解壓打包RAR的實(shí)現(xiàn)方法

javascript處理a標(biāo)簽超鏈接默認(rèn)事件的方法

C#實(shí)現(xiàn)windows form拷貝內(nèi)容到剪貼板的方法

Asp.Net中索引器的用法分析

jQuery 如何給Carousel插件添加新的功能

C++訪問Redis的mset 二進(jìn)制數(shù)據(jù)接口封裝方案

Laydate時(shí)間組件在火狐瀏覽器下有多時(shí)間輸入框時(shí)只能給第一個(gè)輸入框賦值的解決方法

使用VS開發(fā) Node.js指南

Jquery中children與find之間的區(qū)別詳細(xì)解析

c#入門之分支語句使用方法(三元運(yùn)算符、if語句、switch語句)

textarea焦點(diǎn)的用法實(shí)現(xiàn)獲取焦點(diǎn)清空失去焦點(diǎn)提示效果

全面了解java byte數(shù)組與文件讀寫

iOS8中如何集成TouchID指紋傳感器功能

總結(jié)

以上是生活随笔為你收集整理的java 注释 超链接_java_Java代码注释规范详解，代码附有注释对程序开发者来 - phpStudy...的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

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