国产探花免费观看_亚洲丰满少妇自慰呻吟_97日韩有码在线_资源在线日韩欧美_一区二区精品毛片,辰东完美世界有声小说,欢乐颂第一季,yy玄幻小说排行榜完本

首頁 > 編程 > Java > 正文

Java代碼注釋規范詳解

2019-11-26 14:37:59
字體:
來源:轉載
供稿:網友

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

基本的要求:

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代碼注釋規范,希望對大家有所幫助。

發表評論 共有條評論
用戶名: 密碼:
驗證碼: 匿名發表
主站蜘蛛池模板: 绥化市| 宕昌县| 鹰潭市| 集贤县| 秦安县| 西安市| 若羌县| 土默特左旗| 荃湾区| 东海县| 稷山县| 邹城市| 乳源| 武邑县| 宁阳县| 岢岚县| 庆阳市| 开封县| 冀州市| 甘谷县| 三亚市| 康平县| 武胜县| 晋中市| 德清县| 凤庆县| 突泉县| 来凤县| 西安市| 通州区| 青冈县| 慈利县| 芦山县| 临海市| 七台河市| 阳泉市| 如皋市| 荔浦县| 东兰县| 岳阳市| 湘潭市|