※ 引述《alihue (wanda wanda)》之銘言：
: 轉自推特
: https://twitter.com/BenLesh/status/1372562839475470336?s=20
: Add comments about WHY code exists, not what it does.
: The code is right there, we know what it does.
: 註解應該用來解釋這段 code 的背景需求/含意，
: 而不是把 code 表面上的意思再講一次
上週在重構某段程式碼時，其中一位同事在 code review 中建議把某個註解刪掉，另一
個同事看到這個評論時，在下面留了言說他認為不應該刪掉，於是我們就拉了一個小討論
，聊在程式碼中寫註解這件事。
因為這個經驗，我回去重翻史丹佛電腦科學教授 John Ousterhout 寫的《A Philosophy
of Software Design》一書，並整理了筆記。該教授的觀點是認為程式碼寫註解有很多好
處，但不是任何地方都該寫註解。
在版上找到這篇之前有版大發的文，基本上跟 John Ousterhout 教授的觀點一樣，
就是註解要解釋背後的「為什麼」，而不是把程式碼做的事重複說一次。