※ 引述《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 教授的观点一样，
就是注解要解释背后的“为什么”，而不是把程式码做的事重复说一次。