重视代码注释

代码是给人看的,机器码才是给计算机执行的。所以写代码时,应简练整洁,更要便于人类理解。注释可以帮助人们理解代码的功能,就像几何题目中的辅助线,盖楼房时的脚手架。好的注释可以帮助人们更好的理解代码执行流程,理解总体架构。作者可以把自己的想法,为什么这么写,未来的重构方向,在注释中体现。


注释也可以作为很好的参考文献,可以把代码段,文档网址链接,长函数的形式参数以行间注释的形式记录下来,就和写日记一样。


多阅读高质量的开源软件,看看他们的注释是怎么写的。


References

1. The Art of Readable Code, Dustin Boswell & Trevor Foucher 著

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值