目錄

強制

推薦

參考

---

強制

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

2.所有的抽象方法（包括接口中的方法）必須使用javadoc注釋，除了返回值、參數、異常說明外，還必須指出該方法做什么事情，實現什么功能。

3.所有的類都必須添加創建者和創建日期。

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

5.所有的枚舉類型必須要有注釋，說明每個數據項的用途。

推薦

1.與其“半吊子”英文來注釋，不如用中文注釋把問題說清楚。專有名詞和關鍵字保持英文原文即可。

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

參考

1.謹慎注釋掉代碼。在上面詳細說明，而不是簡單地注釋掉。如果無用則刪除。注釋刪掉會用兩種可能性：1.后續會恢復此段代碼邏輯。2.永久不用。前者如果沒有備注信息難以知曉其動機，后者建議直接刪掉。

2.對于注釋的要求：能夠準確反映設計思路和代碼邏輯；能夠描述業務含義，使別的程序員能夠迅速了解到代碼背后的信息。完全沒有注釋的大段代碼對于閱讀者如同天書。

3.好的命名、代碼結構是自解釋的，注釋力求精簡準確，表達到位。避免出現注釋的一個極端：過多的注釋，代碼邏輯一旦修改，注釋的修改是相當大的負擔。

4.特殊注釋標記，要注明標記人和標記時間。并且要及時處理這些標記，通過標記掃描，經常清理此類標記。

• ?? ?代辦事宜（TODO）：表明需要實現但目前還未實現的功能。
• ?? ?錯誤（FIXME） ? ：表明某代碼是錯誤的，而且不能工作，需要及時糾正。

總結

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

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