注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败。即当总无法找到不用注释就能表达自我的方法时去使用注释。因此,尽量使用代码(命名)来表达意图而不是注释。如果要使用注释,注释尽量简洁明了。
之所以要尽量少用注释,因为程序员不能坚持维护注释,注释存在的时间越久,就离其所描述的代码越远,越来越变得全然错误。
注释不能美化糟糕的代码
写注释的常见动机之一是糟糕的代码的存在,与其花时间编写解释你搞出的糟糕的代码的注释,不如花时间清洁那堆糟糕的代码。
值得写的注释
提供基本信息的注释(参数,函数,返回值等的信息),对某段代码块编写意图的解释,对一些晦涩难懂信息的阐述注释,警示注释,TODO注释。
坏注释
提供的信息不够充足的注释,多余重复的注释,误导性注释(注释逻辑与代码逻辑有偏差),循规式注释(如要求每个变量都要有注释,为了写注释而写注释),日志式注释,特定位置标记的注释(滥用注释),注释掉的代码,HTML 注释,不易理解的注释。