编程基本功:代码即注释,文字类注释要谨慎

  关于注释,吾有几个言论:

  • 注释无用。
  • 注释有害。因为对错不知。写的人意思很难表达清楚,表达清楚了阅读者很难正确理解。
  • 前一文,吾提出一个惊天神论:注释是程序员赠送给公司的,不写也没错。这比注释无用论、有害论更进了一步。

  有人就奇怪了,大哥你说注释无用、注释有害,那么什么有用?当然是代码啊。代码是程序员的工作,做好工作才是关键。实际上现在要求写好代码,代码就是注释。包括:

  • 命名清楚、准确。文件名、类名、函数名、字段名、参数名、变量名,没有歧义。比如说,在视图中不要用left表示剩下的意思,因为别人会理解为左。
  • 代码分类正确,都在适当的位置。吾近来花了一些时间,把布局的代码从视图中剥离出来。这听起来是不是很正常的工作?这些代码存在也有20年了,从多少人手上经过都说不清楚,只有吾才这样做,是不是震惊了?
  • 代码整齐。能对齐的尽量对齐,如等号、同类变量等。
  • 访问关系正确。比如,能够不用public就不用。
  • 无垃圾。比如已经不要的代码,不使用的代码,无用注释。
  • 利用语言特性,表达意思。比如java中用final表示这个参数不可修改,就是很好的习惯。
  • 在代码中加文字注释一定要谨慎。

  听着很简单?汝试试自己能不能做到,周围的人有没有能做到的。

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

柳鲲鹏

能给阁下一点帮助,非常荣幸

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值