文章目录
  1. 1. 常用的评判代码质量的标准
  2. 2. 如何才能写出高质量的代码

编写高质量代码,提高复杂代码的设计和开发能力;让读源码、学框架事半功倍;

常用的评判代码质量的标准

  • 可维护性(maintainability)
    代码分层清晰、模块化好、高内聚低耦合、遵从基于接口而非实现编程的设计原则

  • 可读性(readability)
    符合编码规范、命名是否达意、注释是否详尽、函数是否长短合适、模块划分是否清晰、是否符合高内聚低耦合

  • 可扩展性(extensibility)
    在不修改或少量修改原有代码的情况下,通过扩展的方式添加新的功能代码。

  • 灵活性(flexibility)
    代码易扩展、易复用或者易用

  • 简洁性(simplicity)
    Keep It Simple,Stupid, 思从深而行从简,真正的高手能云淡风轻地用最简单的方法解决最复杂的问题

  • 可复用性(reusability)

  • 可测试性(testability)

如何才能写出高质量的代码

要写出高质量代码,需要掌握一些更加细化、更加能落地的编程方法论,这就包含面向对象设计思想、设计原则、设计模式、编码规范、重构技巧等。

  • 面向对象编程因为其具有丰富的特性(封装、抽象、继承、多态),可以实现很多复杂的设计思路,写出可复用的代码,是很多设计原则、设计模式等编码实现的基础。

  • 设计原则是指导代码设计的一些经验总结,比如,设计原则中的单一职责、DRY、基于接口而非实现、里式替换原则等,可以让我们写出可复用、灵活、可读性好、易扩展、易维护的代码

  • 设计模式是针对软件开发中经常遇到的一些设计问题,总结出来的一套解决方案或者设计思路。应用设计模式的主要目的是提高代码的可扩展性,写出易扩展的代码。

  • 编程规范主要解决的是代码的可读性问题。编码规范相对于设计原则、设计模式,更加具体、更加偏重代码细节、更加能落地。持续的小重构依赖的理论基础主要就是编程规范。

  • 重构作为保持代码质量不下降的有效手段,利用的就是面向对象、设计原则、设计模式、编码规范这些理论。

better-coding

作者署名:朴实的一线攻城狮
本文标题:如何编写高质量代码
本文出处:http://researchlab.github.io/2021/02/19/better-coding/
版权声明:本文由Lee Hong创作和发表,采用署名(BY)-非商业性使用(NC)-相同方式共享(SA)国际许可协议进行许可,转载请注明作者及出处, 否则保留追究法律责任的权利。

@一线攻城狮

关注微信公众号 @一线攻城狮

总访问:
总访客: