我們該不該寫註釋

我們平時在編碼時總是伴隨著程式碼與註釋，已經成為了一直習慣，那我們應不應該去寫註釋呢？

要回答這個問題，我們需要首先來看我們平時寫註釋的動機，既然平時經常去寫，肯定有寫的理由。概括來講，就是有一些程式碼無法說明的東西需要通過註釋來表達出來，讓閱讀者更加方便理解。

最多就是對於程式碼的解釋。基於這種情況，似乎理由顯而易見，因為寫了之後可以為程式碼帶來更好的說明。那有沒有不寫註釋又能夠解釋程式碼的方式呢，最常見的一種方式就是通過一些重構的方式以及合理的命名 來實現。如果可以達到同樣的效果，當然是通過程式碼來進行描述更合適，因為在修改程式碼之後肯定會對程式碼的名稱進行同步的修改，而對於註釋則會遺漏，這樣的話就會導致本來是對程式碼進行解釋的結果造成了誤導（同步修改註釋是一件比較耗時而且難以去實現的事情）。那如果沒有辦法通過程式碼的方式來進行說明的，就需要新增上註釋，直到找到程式碼重構的方法。其次是由於語言的差異 問題，就算可以用適合的英文名來說明，但是中英文之間的差異還是很難讓閱讀者一眼就知道程式碼的含義，因此加上簡短的中文註釋也有幫助。另外一個原因可能是對概念的不熟悉，如果是一些大家都熟知的概率，那就不需要去解釋，例如汽車可以開，可以停，加油等等，而在一些其它的場景下對於抽象出來的概念通過註釋也是一種比較好的解釋方式，當然也可以通過使用docs來說明。

如果不是對程式碼的說明例如提醒（提醒要做什麼、不該做什麼）等，寫註釋也是有好處，雖然也可以通過外部文件的方式來說明，但是沒有註釋來的更加的直接方便。

因此，該不該寫註釋還是依場景來判斷，最好是可以通過程式碼的方式來解釋，然後加上一些概念的解釋以及簡短的中文翻譯，如果還不足以說明再通過註釋來補充（必須是通過思考之後的）。