1、不準確的註釋比沒有註釋更令人頭疼
儘量用語義化的代碼來解釋你的意圖,而不是依賴註釋來解釋一段代碼 原因很簡單:程序員不能堅持維護註釋。 代碼在後期維護中,不斷的優化、變動,很有可能最初的註釋已和現有的代碼沒多大關係了,反而給人一種先入爲主的思想去了解一段代碼。
儘量用語義化的代碼來解釋你的意圖,而不是依賴註釋來解釋一段代碼
原因很簡單:程序員不能堅持維護註釋。 代碼在後期維護中,不斷的優化、變動,很有可能最初的註釋已和現有的代碼沒多大關係了,反而給人一種先入爲主的思想去了解一段代碼。
2、如果一定要寫註釋,請保證它描述的是離它最近的代碼
函數 1Small 小巧 2Do One Thing 只做一件事 怎麼知道什麼是 DO ONE THING 3One Level of Abstraction per Functions 函數邏輯應處於同一層抽象