寫好註釋的方法小結

關於如何寫好代碼註釋：

  註釋的恰當用法是彌補咱們在用代碼表達意圖時遭遇的失敗。

  程序中，真實只存在一處地方：代碼。應該儘可能使用代碼表達，而儘可能減小注釋。

 什麼樣的註釋纔是好的註釋：

1.法律信息。

2.提供信息的註釋。

3.對意圖的解釋。提供了某個決定背後的意圖（好比在程序中寫入了某些「匪夷所思」的代碼，提供註釋來告訴閱讀者這些代碼的用途）。

4. 闡釋。註釋把某些晦澀難明的參數或者返回值的意義翻譯成某種可讀形式。

5.警示，用於警告其餘程序員會出現某種後果的註釋。

6. TODO註釋 。TODO是一種程序員認爲應該作但出於某些緣由還沒作的工做。記得按期查看TODO註釋，而且完成該工做後，刪除再也不須要的。（我在當前的andriod團隊開發中深有感觸，大有益處，IDE通常也提供了尋找TODO註釋的快捷途徑）。

7.放大。某些註釋能夠用來放大某種看起來不合理之物的重要性。（一般此種註釋的篇幅有多行以上，容易吸引眼球）。

8. 公共API中的Javadoc。

對一些「壞」註釋的補救方案：

1.右括號註釋。即有一個巨大的代碼塊，包含了多個if，for，while語句，出於方便在對應的右括號後加註釋標識是哪一個語句的結束。 —— 解決辦法：縮短函數

2. 註釋掉的代碼。 千萬別這麼作，由於其餘人不敢刪除註釋掉的代碼，他們會猜想那些註釋掉的代碼放在那裏必定有緣由。

總結：

儘可能少寫註釋，努力強化代碼表達能力。