如何提高代码质量

本文强调了编程中的关键要素,如先写注释以引导思路,使用清晰的变量命名体现业务理解,以及定期重构代码以保持可读性和适应性。通过遵循命名规范和重构策略,提升代码的可维护性与可读性。
摘要由CSDN通过智能技术生成

高质量代码是可读性强、易于测试,它们能够恰如其份的表达业务的需要,并能根据业务需要易于修改的代码。

一、先写注释,再写代码

  1. 清晰的思路是编程行动的良好指南,花点时间思考一下,不要一接到任务就动手编代码,从而陷入技术细节不可自拔。
  2. 利用空白或空白行合理分隔代码,也是一种良好的注释。就像好的文章印刷时,段落间距要大一点是一样的。
  3. 使用region合理分隔代码,同时在region中加入注释。特别是,一定要把私有函数聚集到region中折叠起来,不要与公有函数(或事件函数)交叉,因为我们阅读代码往往是从公有函数(或事件函数)入手的。这可以隐藏细节,使代码看起来更整洁。

二、给变量起一个好名字

  1. 合理的变量命名是代码可读的基础。好的命名,不仅仅是使得代码易读,它代表了你对业务领域的理解,对程序逻辑的认知,对项目框架的把握。所以,好的程序员很多时候纠结的不是技术实现问题,而是如何为变量起一个好名字,使得代码读起来流畅,能让更多的人理解。
  2. 遵循一些成熟的命名规范,PascalCasing、camelCasing等。
  3. 命名规范不是一成不变的,在特定场景下可以有自己风格的约定,前提是要使代码保持一致、易读。比如,一般我们强烈反对使用汉语拼音命名变量,可是在有些项目中,特别是涉及国内政府、院校的信息标准时,其数据库字段(量很大)完全是按汉语拼音首字母制定的,如果非要翻译成英文就有点矫枉过正了(工作量本身也很大)。

三、重构你的代码

  1. 嗅嗅代码的坏味道:如果你检测到不符合设计规范的代码,如果你写了过长的函数,如果你发现你在重复拷贝相同的代码段是时候重构你的代码了!具体可以查看《设计模式-重构》

  2. 常见的重构对策:

  • 不要在一个方法中,写下上百行的逻辑代码。 把各小逻辑代码独立出来,写于其它方法中,易读其可重复调用。
  • 写类,写方法,写功能时,应考虑其移植性,复用性:防止一次性代码!
  • 熟练运用抽象的思想,找出应用中相同之处,且不容易发生变化的东西,把它们抽取到抽象类中,让子类去继承它们;
  • 找出应用中可能需要变化之处,把它们独立出来,不要和那些不需要变化的代码混在一起。

编程的过程实际是一个不断重构(改进)的过程。通过不断重构,可以去除代码的坏味道,编写可读性更好的代码。同时也深化了你对设计的理解,提高了你的编程素养。

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值