定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。（這些規(guī)范并不是一定要絕對遵守，但是一定要讓程序有良好的可讀性）。

Java 的語法與 C++ 及為相似，那么，你知道 Java 的注釋有幾種嗎？是兩種？ 　　

// 注釋一行　　

/* ...... */ 注釋若干行

不完全對，除了以上兩種之外，還有第三種，文檔注釋： 　　

/** ...... */ 注釋若干行，并寫入 javadoc 文檔

1、注釋要簡單明了。

String userName = null; //用戶名

2、邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。

3、在必要的地方注釋，注釋量要適中。注釋的內(nèi)容要清楚、明了，含義準確，防

止注釋二義性。保持注釋與其描述的代碼相鄰，即注釋的就近原則。

4、對代碼的注釋應放在其上方相鄰位置，不可放在下面。對數(shù)據(jù)結構的注釋應放在

其上方相鄰位置，不可放在下面；對結構中的每個域的注釋應放在此域的右方；

同一結構中不同域的注釋要對齊。

5、變量、常量的注釋應放在其上方相鄰位置或右方。

6、全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以

及存取時注意事項等的說明。

7、在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本號；作者；生成日

期；模塊功能描述（如功能、主要算法、內(nèi)部各部分之間的關系、該文件與其它文

件關系等）；主要函數(shù)或過程清單及本文件歷史修改記錄等。

/**
   * Copy Right Information   : Neusoft IIT
   * Project                        : eTrain
   * JDK version used           : jdk1.3.1
   * Comments                  : config path
   * Version                       : 1.01
   * Modification history     :2003.5.1
   * Sr Date   Modified By   Why & What is modified
   * 1. 2003.5.2 Kevin Gao     new
   **/

8、在每個函數(shù)或過程的前面要有必要的注釋信息，包括：函數(shù)或過程名稱；功能描

述；輸入、輸出及返回值說明；調(diào)用關系及被調(diào)用關系說明等

 /**
      * Description :checkout 提款
      * @param Hashtable cart info
      * @param OrderBean order info
      * @return String
      */
     public String checkout(Hashtable htCart, OrderBean orderBean) throws Exception
     { }

9、javadoc注釋標簽語法

@author 對類的說明 標明開發(fā)該類模塊的作者
@version 對類的說明 標明該類模塊的版本
@see 對類、屬性、方法的說明 參考轉(zhuǎn)向，也就是相關主題
@param 對方法的說明 對方法中某參數(shù)的說明
@return 對方法的說明 對方法返回值的說明
@exception 對方法的說明 對方法可能拋出的異常進行說明