詳解Java程式碼註解規格(動力節點整理)

程式碼註解是架起程式設計者與程式閱讀者之間的通訊橋樑，最大限度的提高團隊開發合作效率。也是程式碼可維護性的重要環節之一。以下透過本文說一下我們在日常開發中使用的程式碼註解規格

程式碼註解是架起程式設計者與程式閱讀者之間的通訊橋樑，最大限度的提高團隊開發合作效率。也是程式碼可維護性的重要環節之一。所以我們不是為寫註釋而寫註釋。下面說一下我們在日常開發中使用的程式碼註解規範，供大家參考下。

1、 註釋形式統一

在整個應用程式中，使用具有一致的標點和結構的樣式來建構註解。如果在其它專案中發現它們的註解規格與這份文件不同，依照這份規格寫程式碼，不要試圖在既成的規格系統中引入新的規格。

2、 註釋內容準確簡潔

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

註解條件：

1、基本註解

(a)    類別（介面）的註解

(b)    建構子的註解

(c)     方法的註解

(d)    全域變數的註解

(e)    欄位/屬性的註解

 備註：簡單的程式碼做簡單註釋，註解內容不大於10個字即可，另外，持久化物件或VO物件的getter、setter方法不需加註解。具體的註解格式請參考下面舉例。

2、特殊必加註解

(a)    典型演算法必須有註解。

(b)    在程式碼不明晰處必須有註解。

(c)     在程式碼修改處加上修改標識的註解。

(d)    在循環和邏輯分支組成的程式碼中加註解。

(e)    提供他人的介面必須加詳細註解。

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

註解格式：

1、單行(single-line)註解：「//……」

2、區塊(block)註解：「/*&*/」

3、文件註解：「/**&*/」

##4、javadoc 註解標籤語法

@author   對類別的說明標示發展此類別模組的作者

@version   對類別的說明標示該類別模組的版本
@see     對類別、屬性、方法的說明轉向，也就是相關主題
@param    對方法的說明對方法中某參數的說明
@
return   對方法的說明對方法傳回值的說明#@
exception  對方法的說明對方法可能拋出的例外進行說明

參考範例：

1. 類別（接口)註解

例如：

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

2.   建構方法註解

例如:

public class Test extends Button {
 /**
 * 构造方法 的描述
 * @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;//发送人姓名
 private String title;//不能超过120个中文字符
 private String content;//邮件正文
 private String attach;//附件，如果有的话
 private String totalCount;//总发送人数
 private String successCount;//成功发送的人数
 private Integer isDelete;//0不删除 1删除
 private Date createTime;//目前不支持定时 所以创建后即刻发送
 privateSet<EmailList> EmailList;
……
}

其實規範是自己訂的，只要團隊中大家都統一遵守，統一規範，就會取得好的效果，希望對平常不加註解的朋友有點幫助。

以上是詳解Java程式碼註解規格(動力節點整理)的詳細內容。更多資訊請關注PHP中文網其他相關文章！