資訊專欄INFORMATION COLUMN
摘要：下面說一下我們在訴求網二期開發中使用的代碼注釋規范，供大家參考下。在代碼不明晰處必須有注釋。在代碼修改處加上修改標識的注釋。在循環和邏輯分支組成的代碼中加注釋。
代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以我們不是為寫注釋而寫注釋。下面說一下我們在訴求網二期開發中使用的代碼注釋規范，供大家參考下。
原則：
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 對方法的說明 對方法可能拋出的異常進行說明
參考舉例：
類（接口）注釋
例如：
/**
* 類的描述
* @author Administrator
* @Time 2012-11-2014:49:01
*
*/
public classTest extends Button {
……
}
構造方法注釋
例如:
public class Test extends Button {
/**
* 構造方法 的描述
* @param name
* 按鈕的上顯示的文字
*/
public Test(String name){
……
}
}
方法注釋
例如
public class Test extends Button {
/**
* 為按鈕添加顏色
*@param color
按鈕的顏色
*@return
*@exception (方法有異常的話加)
* @author Administrator
* @Time2012-11-20 15:02:29
*/
public voidaddColor(String color){
……
}
}
全局變量注釋
例如：
public final class String implements java.io.Serializable, Comparable,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 …… }
字段/屬性注釋
例如：
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;
……
}
文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。
轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/67890.html
摘要：今日份重點命名規范注釋關鍵字關鍵字總結命名規范規范的包名名字管理是所有編程語言都必須重視的一個問題。比如說百度，其域名為，那么其對應的應用的包名前綴就應該為。是誰這么大牌總結本文主要介紹了中的命名規范注解關鍵字關鍵字等內容。 歡迎關注我的微信公眾號，共同打牢Java的基礎，向著遠方進擊 showImg(https://segmentfault.com/img/bVboaBO?w=129...
摘要：大家好，我是樂字節的小樂，這次要給大家帶來的是變量與數據類型。本文是第一集編程規范，關鍵字與標識符。后面我們要寫一個程序的過程。需求分析實現代碼體現注釋的作用解釋說明程序，提高了代碼的閱讀性。可以幫助我們調試程序。 大家好，我是樂字節的小樂，這次要給大家帶來的是Java變量與數據類型。本文是第一集：Java編程規范，關鍵字與標識符。showImg(https://segmentfaul...
摘要：努力避免硬編碼。一個類的總體行數盡量控制在行左右不超過一千行。函數注釋函數注釋采用，在每個函數或者過程的前面要有必要的注釋信息，包括函數或過程名稱功能描述輸入輸出及返回值說明調用關系及被調用關系說明等。 前言 推薦Google的Java編碼規范英文版： http://google-styleguide.googlecode.com/svn/trunk/javaguide.html 雖然...
摘要：前言作為一名全干打字員，干活時經常會被要求使用各種各樣的語言去實現各種各樣的需求，來回切換起來寫的代碼就會或多或少有點不規范。今天我們以為例，講講在代碼中，我們需要注意的某些規范。 前言 作為一名全干打字員，干活時經常會被要求使用各種各樣的語言去實現各種各樣的需求，來回切換起來寫的代碼就會或多或少有點不規范。今天我們以JAVA為例，講講在代碼中，我們需要注意的某些規范。（本文標準依賴于...
摘要：對變量對象或者函數等進行命名時，選擇能清晰表達其用途的名字。其實，測試方法名應該明確指出測試的內容與條件。和這種命名方式是時代的前朝遺物。使用自己的異常類型筆者又一次錯誤地認為這一開發習慣是業內的共識。 作為 Java 開發人員，我們會遵循一系列的編碼風格和開發習慣。習慣使然是一方面，另一方面，我們也從不停下腳步質疑這些習慣。一段時間以后，筆者養成了一些不同于常人的編碼風格和開發習慣。...
閱讀 2623·2023-04-26 00:07
閱讀 2432·2021-11-15 11:37
閱讀 639·2021-10-19 11:44
閱讀 2164·2021-09-22 15:56
閱讀 1717·2021-09-10 10:50
閱讀 1497·2021-08-18 10:21
閱讀 2565·2019-08-30 15:53
閱讀 1630·2019-08-30 11:11
