· 代碼註釋是一個好習慣，從開始寫代碼時我就一直是這麼以爲的。最近閱讀了很多大牛的書，然後經過大量自我的思考，我知道了，註釋什麼時候該加，什麼時候該刪。
1.註釋不是"除臭劑"
· 註釋 作爲解釋代碼邏輯的手段的確很重要，特別是對於那些邏輯複雜，難以理解的部分，這可以讓後續的修改者更快理解代碼的初衷。
· 但是，如果代碼邏輯 本身有問題，這時，註釋 就成了 “除臭劑”，爲了解釋代碼的"複雜"邏輯而存在。
· 就像，如果你的衛生間髒的難以忍受，而你只在這裏放了一個除臭劑，來安慰自己能在這裏待下去，這真的是應該做的嗎？
· 因此，如果是這種情況，你應該勇於 修改代碼邏輯，讓其變得清晰和整潔。
· 不要想着，我只是在這裏待一會就走，放個除臭劑沒啥不好的。這樣的 “忍耐力” 可能會讓你更加的 平庸。沒有高標準，何來大師名。這個是我對自己的告誡。
2.真的好代碼
· 我總結了好代碼的通俗定義： 一眼就知道代碼邏輯結構，一眼就知道變量的類型和含義，一眼就知道函數的用法和參數意義。
· 要實現這個目的，有以下幾個標準，我分別和打掃房間做了類比：
- 代碼簡潔 (房間一塵不染)
- 邏輯清晰 (傢俱佈局合理)
- 函數名和變量名 規範 (傢俱上的物件擺放整齊)
- 如果邏輯複雜度不能降低，可以加註釋。(如果傢俱並不協調，佈局難以合理，可以加點裝飾品來掩蓋一下)
· 加了類比之後，我相信大家能更好的理解好代碼含義了。
3.註釋的使用場景
· 通過以上的好代碼含義，我們知道了註釋在 好代碼 中的位置。
· 但是，這並未意味着 註釋平時要少用，恰恰相反，在大多數場景中，註釋應該多多使用。有如下場景：
1. 不知道該做啥；
在開始設計代碼時，可能遇到不知道做什麼的時候，可以用註釋來表示最開始的思路 和 後續的計劃，通過僞代碼展示出代碼的基本框架；
後續在代碼完成之後，可以最後刪掉大部分的註釋，保留部分必要的部分。
2. 沒有十足把握的時候；
· 在設計代碼時，可能遇到並無很大把握的情況，特別是代碼設計的"交叉路口"，這個時候就需要 用註釋寫出 自己的思維決策過程，這樣設計的原因，方便後續遇到問題時，如何回溯問題，找到解決辦法。
3. 還未理解別人代碼邏輯的時候。
· 在負責修改別人實現的功能時，可能遇到一些"古董級"老代碼，這些代碼可能邏輯複雜，代碼冗長，難以理解，這個時候就可以通過代碼註釋來逐步理清代碼的真實邏輯，
· 然後逐步的重新設計代碼，當代碼越來越好的時候，註釋也就可以慢慢退場的。
· 最後，我們要牢記，我們重構代碼的目的就是讓這些註釋都變得多餘，直至消失。
如果覺得我的文章還有點收穫，就點個贊吧！ d=====(￣▽￣*)b