1. 了解什么不需要注释
2. 用代码记录你的思想
3. 站在读者的角度，去想象他们需要知道什么
好代码 > 坏代码 + 注释
为代码中的瑕疵写注释：
TODO： 我还没有处理的事情
FIXME： 已知的无法运行的代码
HACK： 对一个问题不得不采用的比较粗糙的解决方案
XXX: 危险，这里有重要的问题
给常量加注释
《编写可读代码的艺术》《第5章 该写什么样的注释》
原文：https://www.cnblogs.com/focus-z/p/12180618.html
