代碼附有註釋對程序開發者來說非常重要,隨著技術的發展,在項目開發過程中,必須要求程序員寫好代碼註釋,這樣有利於代碼後續的編寫和使用。
基本的要求:
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代碼註釋規範,希望對大家有所幫助。