聊聊代码质量 - 《学得会,抄得走的提升前端代码质量方法》前言

1,156 阅读3分钟

点击一键订阅《云荐大咖》专栏,获取官方推荐精品内容,学技术不迷路!

3金伟强.jpg

代码质量对公司和个人都很重要。但提升代码的方式有很多,在时间和资源有限的情况下,我们该做哪些?以及做的先后顺序是怎样的?

213.png

代码质量对公司和个人都很重要。

对公司来说,公司期望高质量的产品。代码质量会直接体现到产品质量上。代码质量差往往会导致产品质量差。同时,公司期望开发产品的速度快。代码质量好,有利于提升开发速度。反之,改代码质量差的代码,就像在保持不塌的情况下,移动岌岌可危的乐高搭的高楼中的积木,速度快不起来。

对个人来说,代码质量是程序员专业能力的体现。能写出高质量的代码,有助于找到好工作和升职加薪。

因此,我们都期望提升代码质量。

提升代码质量的方法

提高代码质量的方法有很多,比如:

  1. 统一代码风格。
  2. 给文件,类,函数,变量等起有意义的名字。
  3. 在必要的地方加注释。
  4. 合理的使用编程方法论。DDD(领域驱动设计),面向对象编程,函数式编程。
  5. 合理的使用设计原则和设计模式。
  6. 写测试用例。
  7. 持续集成
  8. 代码扫描。
  9. Code Review。
  10. 结对编程。
  11. 挑选高质量的第三方库。
  12. ...

方法这么多,在时间和资源有限的情况下,我们该做哪些?以及做的先后顺序是怎样的?

提升代码质量的顺序

《学得会,抄得走的提升前端代码质量方法》系列文章是对上面问题的回答。

代码质量由 3 个部分组成:

  1. 实现业务功能。
  2. 代码的可读性。
  3. 代码的复杂度。

高质量的代码首先是实现了业务功能的,然后有很好的可读性,最后,代码的复杂度控制在一个可接受的范围。提高代码质量的方法,都可以归类为这 3 个部分。系列文章根据这 3 个部分,将代码质量从坏到好为 5 个阶段。如下图所示:

image.png

提升代码质量,应该从下层往上层做。

代码的价值在于实现业务功能。不能实现业务功能的代码,写的再好也没有价值。因此,代码首先要实现业务功能。

读代码是个高频操作。每次改代码前,都会读代码。同时,提升代码的可读性,成本不是很高。从投入产出的角度来看,提升代码可读性的性价比高。

最后,就是降低代码的复杂度。要降低代码的复杂度,需要花大量时间去做调研和设计,往往还会走一些弯路。降低复杂系统的复杂度,对团队和个人来说,都是一个挑战。因此,把这块放到最后。

文章会详细介绍每个阶段的特征,以及如何达到的方法。

3金伟强.jpg

《云荐大咖》是腾讯云加社区精品内容专栏。云荐官特邀行业佼者,聚焦于前沿技术的落地及理论实践之上,持续为您解读云时代热点技术、探索行业发展新机。点击一键订阅,我们将为你定期推送精品内容。