首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

代码注释比脸都干净,这样的程序员坏的很

上个月项目组有同事要离职,由于项目工期比较紧,没有进行详细的交接工作。只是让他把负责项目的目录结构等编写成文档,进行说明,和交接人员进行简单的沟通后就办了离职手续。这两天由于客服需求变更,需要对离职人员当时负责的业务代码进行修改升级,就安排接手的同事将代码从代码库中更新下来进行升级准备。

当同事把代码下载完后,对代码进行修改的时候,突然站起来招呼我过去“你来,你来看看,这货写的这是啥代码呀,所有代码没他妈一行注释,注释比他妈的脸都干净,这让我咋干?”我过去看完以后真的一行注释都没有呀,行了没办法,只能辛苦辛苦,把这块的代码业务逻辑重新梳理一下,不出意外的话今天晚上我给咱们定外卖,我陪你加班,着这块的代码重新梳理一下。

在软件编程的过程中,对于代码注释的理解,有些人觉得这个东西无所谓,可有可无,在代码编译运行的过程中也不运行注释,只要自己的业务实现了就可以了。其实在编程的过程如果养成良好的编程习惯,正常情况下是代码和注释的比例应该达到3:1,也就是所谓的三行代码一行注释。进行代码注释不仅是为了方便别人能够快速读懂你的代码,其实也是方便自己日后进行代码升级,对于复杂的业务逻辑可能代码注释比代码还要多,这样才能在后续工作中提高自己的工作效率。另一方面良好的代码注释还能有效提高个人编码效率,记得自己编码的过程有时候经常是无处下手,如果先写注释后写代码,这样更能理清思路,提高编码效率和质量。这里对于注释不是为了完成任务而写注释,注释一定要根据业务逻辑进行书写,不是写一套注释,我复制一下,就完成了。

今天以后不仅要严格要求自己,在编码的过程中写好代码注释,同时还要对项目整体代码质量进行跟踪,避免只有代码没有注释的情况发生,对编码注释这块制定详细的标准,采用相同的注释模板,提高代码可读性。

代码注释模板

各位看官,你们编程过程中有没有类似的情况呀?热烈欢迎发表评论看法...

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20190728A05LU400?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

相关快讯

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券