程式碼中的註釋是有價值的，通常也是必須的，但沒有註釋更好。本文會解釋其原因。

我的目標是，當我閱讀我編寫程式碼時，應該完全清楚它的作用。名稱，結構，程式碼背後的意圖 – 都需要儘可能的清晰和明顯。

我常常希望通過註釋來增加更多的細節以及待改進的描述，我擔心將來看程式碼時候會面臨看不懂的困惑，所以註釋主要是來幫助將來的我來理解程式碼。當我懷疑程式碼不完全清晰時，我會立即添加註釋。

換句話說，希望寫註釋，經常表示程式碼有更好的改進空間。在某些方面，這實際上是一種警告標誌。

這不是說註釋是壞的。但是如果程式碼已經很清楚表達意思，註釋就不需要了，這樣當然就會更好。而且我們還常常發現註釋甚至不符合程式碼。

註釋的 4 種境界

1、最差

——-

複雜，隱晦的程式碼，沒有任何註釋

2、更好

——-

複雜，隱晦的程式碼與註釋

（大多數現實世界的程式設計師住在這裡）

3、比更好還更好

——-

簡單，清晰的程式碼連同註釋。

4、最好

—–

程式碼如此豐富，註釋完全不必要

補充：

（小編：估計作者寫完此觀點後在網上被噴了，又補充了一些永遠正確的觀點）

為了澄清我的觀點，大家還是應該使用註釋，因為我們大多數人屬於前三個類別，第四個境界是追求。

1. 當代碼的意圖不明顯時使用註釋。
2. 如果執行得到的結果不明顯，請使用註釋。
3. 當呼叫方法的上下文不明顯時使用註釋。

註釋它不是短小的骯髒的一行文字，上面這樣的情況，需要一個描述恰當的段落

但是，我們的目標應該是改變我們的程式設計風格，以儘量減少這種需求。程式碼應儘可能地表明意圖。程式碼應該是清晰透明的。如果您可以選擇改進程式碼的清晰度，而不是使用一個澄清的註釋對其進行修改，那麼請先優化程式碼。

參考連結：

1. 英文版：https://www.quora.com/Are-comments-in-code-a-good-or-bad-thing
2. 圖1來源：http://www.sisodia.in/2012/01/real-programmers-don-comment-their-code.html
3. 圖2來源：http://www.peopleandbits.info/