注释-《代码整洁之道》读书笔记(三)

原文地址：https://liujiao111.github.io/2019/06/20/clean-code-doc/

好的注释有巨大的好处，而坏的注释却是大恶。注释是为了弥补代码表达意图的失败，因此，注释总是一种失败，所以要写注释之前，看看能否用代码来表达
因为代码最可信，代码会变动，而注释不总是跟着变，它会撒谎。

注释不能美化糟糕的代码

尽量将代码写得带有少量注释，而表达式更强、更整洁

用代码来阐述

尽量用代码来表达你的意图
例如：

//Chech to see if the employee is eligible for full benefits
        if((employee.flags & HOURLY_FLAG) && (emplyee.age > 65)) {
            
        }

去掉注释，用代码表达：

if((employee.isEligibleForFullBenefits()) {

}

看吧，不用注释，用代码是不是更清晰了。

好注释

当然，有些注释是必须的，是哪些呢？

• 法律信息
• 提供信息的注释，例如在抽象方法上注释说明该函数的作用以及返回值,当然，最好是可以通过名称命名就表达出意图而非注释
• 提供了对