很多java初學者不善於書寫註釋或者根本不寫註釋，這樣大大降低了程式碼的可讀性。在團隊開發的時候，不寫註釋是大忌，會大大降低開發效率。然而，註釋的書寫也有講究，可不僅僅是//和/**/這麼簡單，下面我們來看一下注釋的規範。

在為具體程式碼編寫註釋的同時，我們應該為下面的幾種情況新增文件註釋

• 包
• 公有類與介面
• 公有的和受保護的構造器及方法
• 公有的和受保護的成員變數

類註釋以/*開始，以/結束，如下：

/**
這是一個類註釋
*/
public class Dog
{

}

方法註釋

每一個方法註釋必須放在所描述的方法之前。除了通用標記之外，還可以使用下面的標記
@param

變數描述
這個標記將對當前方法的"param" (引數)部分新增一個條目。這個描述可以佔據多行並可以使用HTML標記。一個方法的所有@param 標記必須放在一起。
@return描述
這個標記將對當前方法新增"return" (返回) 部分。這個描述可以跨越多行，並可以使用HTML標記。
@throws類描述
這個標記將新增一一個註釋， 用於表示這個方法有可能丟擲異常。

域註釋

只需要對公有成員變數（通常指靜態常量）建立註釋，如：

/**
這是COUNT
*/
public static final int COUNT = 1;

通用註釋

下面的標記可以用在類文件的註釋中。
@author

姓名
這個標記將產生一個” author" (作者) 條目。可以使用多個@author標記，每個author標記對應一個作者。
@version 文字
這個標記將產生個version (版本)條目，這裡的文字可以是對當前版本的任何描述。

下面的標記可以用於所有的文件註釋中。

@since 文字
這個標記將產生一個“ since" (始於)條目。這裡的text可以是對引入特性的版本場述。例如，@since version 1.7.1。
@deprecated 文字
這個標記將對類、方法或變數新增一個不再使用的註釋。文字中給出了取代的建議。例如，

@deprecated Use <
 
code> setVisible(true) </code> instead

通過@see和@link標記，可以使用超級連結，連結到javadoc文件的相關部分或外部文件。