读《A Philosophy of Software Design》——（12）

🤔☕️🤔☕️🤔

• 读《A Philosophy of Software Design》——（12）Why Write Comments？

• 📖：写注释的过程，会提高系统的设计，缺乏注释会让设计跌价不少。

  🤔：写注释，曾经以为这是代码的必须动作，总得在注释里说明代码是什么用途吧，而且信以为真很多年，也实践过很多年。不过令自己困惑的是，每次回头看自己的代码和注释，莫名有点搞笑感。代码不是写得明明白白，为啥还非得有相应的注释，名其曰是规范，不如说是遵守又缺乏反思。每次期待有注释，却没有看到注释的时候，往往是我要修改代码，却一下子决定不了如何修改合适，或怎么修改最佳，也没明白为啥眼下的旧代码，当时就写成这个样子。也就是说，告诉我为何出现费解代码，告诉我如何进行修改和扩展的注释，的确是在实践中最期望看到的注释。既然如此，自己作为改代码时，期待注释的有这样的需求，为何不在自己实践中，写下注释前，问自己三个问题：我的代码是否写得足够清晰，清晰到无需任何注释？如果有地方特殊处理，我有没有注释清楚原委，免得以后人费解，更不想看不懂后心里念叨哪位老兄如此写代码？如果未来有扩展，我是否通过注释讲明白，让后来者上手就干，无需迟疑，更无需困惑？

• 📖：写注释，能够把设计者无法用代码表达的信息写出来。

  🤔：初看这句话，有道理。仔细想，道理在哪里？只是一句显而易见的废话。设计者无法表达的是什么？设计，不就是在约束下寻找可行的解决方案，再选择最合适或最优的解决方案，设计的决策都写在设计文档，为何还要在代码注释无法代码描述的东西，让我感到费解。代码里顶多注释一下，设计文档的哪个地方，有如此编写代码的理由即可。

        —— By 术子米德 @2022.03.30