註釋風格(先後端通用)後端
1、註釋類型:spa
1.用標準註釋格式隱藏代碼而沒必要刪除它們接口
2.用單行註釋解釋實現細節io
2、註釋風格:class
1.使用第三人稱敘述的形式方法
2.編寫獨立的概述margin
3、註釋內容:註釋
1.每一個重要的類、接口、字段和方法都編寫註釋di
2.記得署名
4、內部註釋:
1.僅添加有助於理解代碼的內部註釋
2.描寫代碼爲何這樣作,而不是在作什麼
3.避免使用行尾註釋