关于代码注释的认识更新

          对代码注释我的认识有过几次改变。
          刚工作的公司对注释有所要求,鼓励大家多写注释,作为新人也就接受了这种观点,可能也写了不少“这个类是用来打印hello,world”的废话注释呵呵。或者“int i = 0; //这个变量用来保存用户年度缴纳金额之和”这种不注重变量/函数命名而是使用注释来说明的错误写法。
            后来开发经验渐长,受一些最好的注释就是没有注释的思想影响,倾向于不写任何注释。也实践过一段时间,但是发现在中国这种做法还是有些弊端的:
            1、大家开发水平不同,Common Sense不一样。可能对某些人是常识。对另外的人则是新知识。可能某些人觉得起名很清晰,函数名就能体现算法。但另一些人压根没听说这种算法。
            2、大家的母语不是英语,英语的读写能力并没有这么强。如果用拼音来弄函数名、变量名。又很山寨+受多音字影响。
          目前我对代码注释的认识是:
          1、在适当的地方使用中文注释,可以提高代码的可读性。
          2、有注释不代表可以不管函数名、变量名的可读性,乱取名字。
          3、反对不正确的注释用法,干扰理解,有害无益。
          常见的滥用注释主要有:
          1、废话。比如 int i = 60; // 将i设置为60
          2、注释无用的代码。如果确定代码无用就将其删除。否则就应该使用分支的方法来实现功能,而不是把一部分注释起来。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值