1. 源程序註釋量必須在30%以上
2. 包的註釋:寫入一個名爲 package.html 的HTML格式的說明文件放入包所在路徑。包的註釋內容:簡述本包的作用、詳細描述本包的內容、產品模塊名稱和版本、公司版權。
3. 類和接口的註釋放在class 或者 interface關鍵字之前,import 關鍵字之後。註釋主要是一句話功能簡述與功能詳細描述。類註釋使用“/** */”註釋方式
4. 類屬性(成員變量)、公有和保護方法註釋:寫在類屬性、公有和保護方法上面,註釋方式爲“/** */”。
5. 公有和保護方法註釋內容:列出方法的一句話功能簡述、功能詳細描述、輸入參數、輸出參數、返回值、異常等。
---
對於方法內部用throw語句拋出的異常,必須在方法的註釋中標明,對於所調用的其他方法所拋出的異常,選擇主要的在註釋中說明。 對於非RuntimeException,即throws子句聲明會拋出的異常,必須在方法的註釋中標明。
註釋應與其描述的代碼相近,對代碼的註釋應放在其上方,並與其上面的代碼用空行隔開,註釋與所描述內容進行同樣的縮排。
對於switch語句下的case語句,必須在每個case分支結束前加上break語句。
修改代碼同時修改相應的註釋,以保證註釋與代碼的一致性。不再有用的註釋要刪除。
註釋的內容要清楚、明瞭,含義準確,防止註釋二義性。
避免在註釋中使用縮寫,特別是不常用縮寫。
對重載父類的方法必須進行@Override聲明