《代码整洁之道》笔记03——注释

注释是在代码表达意图时遭遇的失败。

注释不能美化糟糕的代码

用代码来阐述

好注释

  1. 法律信息
  2. 对基本信息的注释
  3. 对意图的解释
  4. 阐释
  5. 警示
  6. TODO注释,程序员认为应该去做,但是由于一些原因没用实现完的注释。
  7. 放大不合理之物的重要性
  8. 公共API描述

坏注释

  1. 喃喃自语/废话注释
  2. 多余的注释
  3. 误导性注释
  4. 循规式注释:不需要给每一个函数进行注释
  5. 日志式注释
  6. 能用函数和变量时就别用注释
  7. 用于位置标识的注释
  8. 注释的代码
  9. 信息过多
  10. 不明显的联系
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值