Question

注释的目的是帮助读者了解作者在写代码时已经知道的那些事情。本章介绍了如何发现所有的并不那么明显的信息块并且把它们写下来。

什么地方不需要注释：

·能从代码本身中迅速地推断的事实。

·用来粉饰烂代码（例如蹩脚的函数名）的“拐杖式注释”——应该把代码改好。

你应该记录下来的想法包括：

·对于为什么代码写成这样而不是那样的内在理由（“指导性批注”）。

·代码中的缺陷，使用像TODO：或者XXX：这样的标记。

·常量背后的故事，为什么是这个值。

站在读者的立场上思考：

·预料到代码中哪些部分会让读者说：“啊？”并且给它们加上注释。

·为普通读者意料之外的行为加上注释。

·在文件/类的级别上使用“全局观”注释来解释所有的部分是如何一起工作的。

·用注释来总结代码块，使读者不致迷失在细节中。