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

🤔☕️🤔☕️🤔

• 读《A Philosophy of Software Design》——（13）Comments should Describe Thinks that aren’t Obvious from the Code

• 📖：读代码不能显然得到的想法，用注释写下来。

  🤔：很赞同。不过，真写代码的时候，会发现，代码脑子写热了，是无法冷静下来想，是否别人能看懂代码。办法就是，先热着脑子写代码，写完调试好代码，把它丢一旁。第二天再来看看自己写的代码，如果看一眼有点疑惑，那就赶紧再这个点补上注释。第三天再来读读自己的代码，能否用口头语言顺利把代码讲清楚，遇到疙瘩的地方，那赶紧补上注释。最后，再提交代码评审，期望评审方先尝试读懂，费解的地方赶紧补上注释。这三轮下来，大概率说，不太再能对注释指指点点。不过，还有个争议点，那就是，注释用英文还是中文，又是个争翻天的观点，或者说只是个偏好问题。个人喜欢用英文注释，理由很简单，那就是代码是英文的，注释是英文的，看起来比较和谐。如果这个理由显得牵强，还有个理由攻击性强一点。那就是我觉得如果这几句英文注释都写不清楚，那么大概率中文注释写出来更加不精准，还不如把功夫花到把代码写得显而易见。

        —— By 术子米德 @2022.03.31