这本书的内容还是非常直白的，在说完了命名之后，讲讲注释应该怎么写，注释分为两个章节，分别解决什么地方该写注释，和注释该怎么写的问题。
先说什么地方该写注释的问题，回忆一下当年写代码的时候，基本上是不太高兴写注释的，总体的想法是懒，秉承的原则是代码写写清楚，比写注释强。
实际上到现在我还是秉承类似的观点，代码要是写得够清晰，是不需要写注释的。书中首先就有两条类似的观点：
不要为了注释而注释。
不要为了不好的命名写注释(应该将命名改好)。
不过还有一些应该写注释的地方：
一是记录你精妙的别人不易理解的设计和实现。
二是提醒自己和别人代码中的缺陷和已知的妥协
三是解释常量的含义，为什么突出常量，我的理解是常量往往缺少上下文，含义经从名字判断往往不够精确。
我认为能做到上面三个注释基本上就达到不错的水准了。
后续的几条看上去就更高端一点，从读者的角度思考下，还有什么要解释的。这部分我感觉属于optional，确实有所感触可以补充。
注释
最后想说说注释和我们的产品设计，在某些方面也是类似的。我们做了一个功能，然后开始写用户手册，用户手册就相当于一个注释。那么最高境界是不需要用户手册，现在大部分的手机系统都做到了这一点。弱一点的是在功能的边上加tips，适当帮助一下理解。再弱一点的就要写用户手册，写一二三步，看懂了再来操作，这就落了下乘了。
网友评论