1. 【強制】類、類屬性、類方法的注釋必須使用 Javadoc 規范，使用 ~~~ /** * 內容 */ ~~~ 格式，不得使用//xxx 方式。 ~~~ 說明：在 IDE 編輯窗口中，Javadoc 方式會提示相關注釋，生成 Javadoc 可以正確輸出相應注 釋；在 IDE 中，工程調用方法時，不進入方法即可懸浮提示方法、參數、返回值的意義，提高 閱讀效率。 ~~~ 2. 【強制】所有的類都必須添加創建者信息。 3. 【強制】方法內部單行注釋，在被注釋語句上方另起一行，使用//注釋。方法內部多行注釋使用/* */注釋，注意與代碼對齊。 4. 【強制】所有的枚舉類型字段必須要有注釋，說明每個數據項的用途。 5. 【推薦】與其“半吊子”英文來注釋，不如用中文注釋把問題說清楚。專有名詞與關鍵字保持英文原文即可。 ~~~ 反例：“TCP 連接超時”解釋成“傳輸控制協議連接超時”，理解反而費腦筋 ~~~ 6. 【推薦】代碼修改的同時，注釋也要進行相應的修改，尤其是參數、返回值、異常、核心邏輯等的修改。 7. 【參考】注釋掉的代碼盡量要配合說明，而不是簡單的注釋掉。 ~~~ 說明：代碼被注釋掉有兩種可能性：1）后續會恢復此段代碼邏輯。2）永久不用。前者如果沒 有備注信息，難以知曉注釋動機。后者建議直接刪掉（代碼倉庫保存了歷史代碼）。 ~~~ 8. 【參考】對于注釋的要求：第一、能夠準確反應設計思想和代碼邏輯；第二、能夠描述業務含義，使別的程序員能夠迅速了解到代碼背后的信息。完全沒有注釋的大段代碼對于閱讀者形同天書，注釋是給自己看的，即使隔很長時間，也能清晰理解當時的思路；注釋也是給繼任者看的，使其能夠快速接替自己的工作。 9. 【參考】好的命名、代碼結構是自解釋的，注釋力求精簡準確、表達到位。避免出現注釋的一個極端：過多過濫的注釋，代碼的邏輯一旦修改，修改注釋是相當大的負擔。