1、類、類屬性、類方法的注釋必須使用Javadoc規范，使用/**內容*/格式，不得使用 //內容 的方式。

說明：在IDE編輯窗口中，Javadoc方式會提示相關注釋，生成Javadoc可以正確輸出相應注釋;在IDE中，工程調用方法時，不進入方法即可懸浮提示方法，參數，返回值的意義，提高閱讀效率。

/** * 類名稱，作用，作者，時間 */ public class Test{/*** 這個字段是id*/private Long id;/*** 保存方法*/public void save(){}}

2、所有抽象方法（包括接口中的方法）必須使用Javadoc注釋，除了返回值、參數、異常說明外，還必須指出該方法做什么，實現什么。對子類的實現或調用注意事項也需要說明。

3、所有類都必須添加創建者信息。

4、方法內部單行注釋，在被注釋語句上方另起一行，使用//注釋。方法內部多行注釋使用/**內容*/，注意代碼對齊。

5、所有枚舉類型字段或是靜態屬性必須有注釋，說明每個數據項的用途。

6、代碼修改的同時，注釋也要修改，尤其是參數、返回值、異常核心邏輯等。

7、注釋掉的代碼盡量配合說明，而不是簡單的注釋掉。如果是以后不用的代碼建議直接刪除。

總結

以上是生活随笔為你收集整理的Java代码注释规约的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。