1、類、類屬性、類方法的注釋必須使用Javadoc規(guī)范，使用/**內(nèi)容*/格式，不得使用 //內(nèi)容 的方式。

說(shuō)明：在IDE編輯窗口中，Javadoc方式會(huì)提示相關(guān)注釋，生成Javadoc可以正確輸出相應(yīng)注釋;在IDE中，工程調(diào)用方法時(shí)，不進(jìn)入方法即可懸浮提示方法，參數(shù)，返回值的意義，提高閱讀效率。

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

2、所有抽象方法（包括接口中的方法）必須使用Javadoc注釋，除了返回值、參數(shù)、異常說(shuō)明外，還必須指出該方法做什么，實(shí)現(xiàn)什么。對(duì)子類的實(shí)現(xiàn)或調(diào)用注意事項(xiàng)也需要說(shuō)明。

3、所有類都必須添加創(chuàng)建者信息。

4、方法內(nèi)部單行注釋，在被注釋語(yǔ)句上方另起一行，使用//注釋。方法內(nèi)部多行注釋使用/**內(nèi)容*/，注意代碼對(duì)齊。

5、所有枚舉類型字段或是靜態(tài)屬性必須有注釋，說(shuō)明每個(gè)數(shù)據(jù)項(xiàng)的用途。

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

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

總結(jié)

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

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。