Java代碼注釋規范詳解

代碼附有注釋對程序開發者來說非常重要，隨著技術的發展，在項目開發過程中，必須要求程序員寫好代碼注釋，這樣有利于代碼后續的編寫和使用。

基本的要求：

1、注釋形式統一

在整個應用程序中，使用具有一致的標點和結構的樣式來構造注釋。如果在其它項目中發現它們的注釋規范與這份文檔不同，按照這份規范寫代碼，不要試圖在既成的規范系統中引入新的規范。

2、注釋內容準確簡潔

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

3、基本注釋(必須加)

(a) 類(接口)的注釋

(b) 構造函數的注釋

(c) 方法的注釋

(d) 全局變量的注釋

(e) 字段/屬性的注

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

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

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

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

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

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

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

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

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

5、注釋格式：

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

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

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

4)、javadoc注釋標簽語法

@author 對類的說明 標明開發該類模塊的作者

@version 對類的說明 標明該類模塊的版本

@see 對類、屬性、方法的說明 參考轉向，也就是相關主題

@param 對方法的說明 對方法中某參數的說明

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

@exception 對方法的說明 對方法可能拋出的異常進行說明

6、例子：

/**

建立一個用于操作數組的工具類，其中包含這常見的對數組的操作的函數:最值。

@author 張三

@version v.

*/

public class ArrayTool{

/**

獲取整形數組的最大值

@param arr 接收一個元素為int類型的數組

@return 該數組的最大的元素值

*/

public int getMax(int arr){

int Max = ;

return Max;

}

}

輸入命令如下圖：

然后在如下的目錄下查看，最后點擊 index.html：

以上內容給大家分享了Java代碼注釋規范，希望對大家有所幫助。相關閱讀:

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

讓Centos解壓打包RAR的實現方法

javascript處理a標簽超鏈接默認事件的方法

C#實現windows form拷貝內容到剪貼板的方法

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

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

C++訪問Redis的mset 二進制數據接口封裝方案

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

使用VS開發 Node.js指南

Jquery中children與find之間的區別詳細解析

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

textarea焦點的用法實現獲取焦點清空失去焦點提示效果

全面了解java byte數組與文件讀寫

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

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。