怎样编写高质量代码

更多文章

什么是高质量代码?

高质量代码具有以下几个特性:

  • 可读性高
  • 构造清晰
  • 可扩大(轻易保护)
  • 代码作风一致
  • 低复杂性
  • 精练

编写高质量代码主要遵照以下几点:

代码范例

代码范例的优点

  • 范例的代码可以增进团队协作
  • 范例的代码可以下降保护本钱
  • 范例的代码有助于代码检察
  • 养成代码范例的习气,有助于程序员自身的生长

每一个程序员最烦的就是修改他人的代码,不管代码优劣。因为第一眼看上去没有熟习感,下意识就会排挤。

所以当团队的成员都严厉根据代码范例来写代码时,可以保证每一个人的代码看起来都像是一个人写的,看他人的代码就像是在看自身的代码。

主要的是我们可以认识到范例的主要性,并对峙范例的开辟习气。

接下来,你要做的事就是找一份优越的代码范例并一向对峙运用,直到构成习气。

前端代码范例引荐

提早设想

在接到一个需求时,万万不要看完需求就立时写代码,以避免形成返工或误会需求的征象。在这个阶段一定要多问,看完需求后,在脑里过一下,把可能会触及的状况都要问清晰。

一位好的程序员不仅仅是一位程序员,还要懂需求、营业。

在把状况都相识清晰后,假如项目范围不是很大,就可以最先写纲要了。

比方如许:

class Car {
  run(){},
  stop(){},
}

然后再最先完成细节。

假如项目范围比较大,可以经由历程头脑导图或其他东西写一个项目标原型(固然这类活平常都会由项目经理或产物来担任),再细分到差别的程序模块来逐一完成。

“磨刀不误砍柴功”,万万不要为了求快而直接写代码。

详细流程

  • 浏览文档,剖析需求
  • 画原型图或草图(轻易自身明白团体架构)
  • 写纲要或伪代码(假如项目比较大还要细分模块)
  • 完成细节

重构

没有程序员能一次就写出圆满的代码,而是须要经由历程不停的重构来完美代码,提拔质量。

重构就是在不转变软件体系外部行动的前提下,改良它的内部构造。

重构可以使软件更容易地被修改和被明白。经由历程不停地革新软件设想以到达简朴设想的目标,削减因为设想与营业的不婚配带来的架构与设想腐蚀。

  • 重构能改良软件设想
  • 重构使软件更容易明白
  • 重构有助于找到Bug
  • 重构有助于进步自我编程才能
  • 重构有助于加深明白代码
  • 重构能顺应需求变动

引荐浏览:重构

代码请求

  • 不要编写大段代码
  • 反复代码封装成函数
  • 在编写代码的历程当中养成不停重构的习气
  • 增加必要的解释
  • 留下可扩大的空间

测试

不管是单元测试、自测或者是别的测试,最主要的目标都是为了找出尽量多的BUG,保证产物的质量。

好的东西都是迭代改出来的,比方好的产物,好的架构,代码也不破例,写的好的代码都是阅历了作者不停地 review 和修改。

测试的历程自身就是一个自我 code review 的历程,在这个历程当中,可以发明一些设想上的题目(比方代码设想的不可测试),代码编写方面的题目(比方一些边界条件的处置惩罚不当)等,做到实时发明实时修改,不须要比及测试阶段以至上线以后再发明再修改。

自我请求

个人认为这一点是最主要的,好的程序员都是有强迫症的,他们会严厉请求自身,经由历程不停的进修来提拔自身的手艺终究成为大神级别的程序员。

假如你不能以高标准来请求自身,纵然你看再多的如何写出高质量代码,懂再多的代码范例,也是没有用,终究照样会写出低质量代码。

然则,进步自我请求是一种转变,平常来说,转变都不是一挥而就的,须要一步一步来。所以,转变最好从小事做起,逐步积聚,终究演变。

发起先从代码范例最先,熟习代码范例,遵照范例写代码,直到成为习气,然后再进修别的要领,终究写出高质量代码。

参考资料

    原文作者:woai3c
    原文地址: https://segmentfault.com/a/1190000017831484
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞