《Clean Code之道》(二)注释、代码格式

注释:
    1、尽量用代码来阐述
    //check to see if the empoyee is eligible for full benefits
    if((employee.flags & HOURLY_FLAG) && (employee.age > 65))
    
    还是这个
    if(employee.isEligibleForFullBeenefits())    
    
    2、保留警告性的注释

    3、日志式、重复性、冗余的、误导性的注释删掉
    //the day of  the month
    private int dayOfMonth
    如果一个变量(或者方法名)还需要注释来说明,那么这个变量(或者方法名)的命名肯定不是最合适的,不应该是添加注释,而是重命名。当然,必要的算法思想解释型注释除外。

    4、注释应该是言简意赅,如果注释本身还需要解释,那可以删掉了。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值