代碼注釋是架起程序設(shè)計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發(fā)合作效率。也是程序代碼可維護(hù)性的重要環(huán)節(jié)之一。所以我們不是為寫注釋而寫注釋。下面說一下我們在日常開發(fā)中使用的代碼注釋規(guī)范，供大家參考下。

1、 注釋形式統(tǒng)一

在整個應(yīng)用程序中，使用具有一致的標(biāo)點和結(jié)構(gòu)的樣式來構(gòu)造注釋。如果在其它項目中發(fā)現(xiàn)它們的注釋規(guī)范與這份文檔不同，按照這份規(guī)范寫代碼，不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。

2、 注釋內(nèi)容準(zhǔn)確簡潔

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

注釋條件：

1、基本注釋

(a)    類（接口）的注釋

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

(c)     方法的注釋

(d)    全局變量的注釋

(e)    字段/屬性的注釋

 備注：簡單的代碼做簡單注釋，注釋內(nèi)容不大于10個字即可，另外，持久化對象或VO對象的getter、setter方法不需加注釋。具體的注釋格式請參考下面舉例。

2、特殊必加注釋

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

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

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

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

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

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

注釋格式：

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

參考舉例：

1. 類（接口）注釋

例如：

/**
* 類的描述
* @author Administrator
* @Time 2016-11-14:49:01
*
*/
public classTest extends Button {
 ……
}

2.   構(gòu)造方法注釋

例如:

public class Test extends Button {
 /**
 * 構(gòu)造方法 的描述
 * @param name
 * 按鈕的上顯示的文字
 */
 public Test(String name){
 ……
 }
}

3.   方法注釋

例如

public class Test extends Button {
 /**
 * 為按鈕添加顏色
 *@param color
  按鈕的顏色
*@return
*@exception (方法有異常的話加)
* @author Administrator
* @Time2012-11-20 15:02:29
 */
 public voidaddColor(String color){
 ……
 }
}

4.   全局變量注釋

例如：

public final class String
 implements Java.io.Serializable, Comparable<String>,CharSequence
{
 /** The value is used for characterstorage. */
 private final char value[];
 /** The offset is the first index of thestorage that is used. */
 private final int offset;
 /** The count is the number of charactersin the String. */
 private final int count;
 /** Cache the hash code for the string */
private int hash; // Default to 0
……
}

5.   字段/屬性注釋

例如：

public class EmailBody implements Serializable{
 private String id;
 private String senderName;//發(fā)送人姓名
 private String title;//不能超過120個中文字符
 private String content;//郵件正文
 private String attach;//附件，如果有的話
 private String totalCount;//總發(fā)送人數(shù)
 private String successCount;//成功發(fā)送的人數(shù)
 private Integer isDelete;//0不刪除 1刪除
 private Date createTime;//目前不支持定時 所以創(chuàng)建后即刻發(fā)送
 privateSet<EmailList> EmailList;
……
}

其實規(guī)范是自己訂的，只要團隊中大家都統(tǒng)一遵守，統(tǒng)一規(guī)范，就會取得好的效果，希望對平時不加注釋的朋友有點幫助。

以上所述是小編給大家介紹的Java代碼注釋規(guī)范(動力節(jié)點整理)，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！

最新評論