美文网首页
高质量的代码

高质量的代码

作者: _1633_ | 来源:发表于2021-01-17 23:28 被阅读0次

        高质量的代码具有:可维护性、可读性、可扩展性、灵活性、简洁性(简单、复杂)、可复用性、可测试性。

    可维护性(maintainability)

        在开发过程中, 维护 就是修改 bug修改老的代码添加新的代码之类的工作。所谓代码易维护就是指,在不破坏原有代码设计、不引入新的 bug 的情况下,能够快速地修改或者添加代码。相反的 代码不易维护 就是指,修改或者添加代码需要冒着极大的引入新 bug 的风险,并且需要花费很长的时间才能完成。

        代码的可读性好、简洁、可扩展性好,就会使得代码易维护;相反,就会使得代码不易维护。更细化地讲,如果代码分层清晰模块化好高内聚低耦合遵从基于接口而非实现编程的设计原则等等,那就可能意味着代码易维护。除此之外,代码的易维护性还跟项目代码量的多少、业务的复杂程度、利用到的技术的复杂程度、文档是否全面、团队成员的开发水平等诸多因素有关。

    可读性(readability)

        我们需要看代码是否符合编码规范、命名是否达意、注释是否详尽、函数是否长短合适、模块划分是否清晰、是否符合高内聚低耦合等等。

    可扩展性(extensibility)

        可扩展性也是一个评价代码质量非常重要的标准。它表示我们的代码应对未来需求变化的能力。跟可读性一样,代码是否易扩展也很大程度上决定代码是否易维护。那到底什么是代码的可扩展性呢?

        代码的可扩展性表示,我们在不修改或少量修改原有代码的情况下,通过扩展的方式添加新的功能代码。简单来说就是,代码预留了一些功能扩展点,你可以把新功能代码,直接插到扩展点上,而不需要因为要添加一个功能而大动干戈,改动大量的原始代码。

    灵活性(flexibility)

        灵活性这个概念比较宽泛,如果一段代码易扩展、易复用或者易用,我们都可以称这段代码写得比较灵活。

    简洁性(simplicity)

        有一条非常著名的设计原则:KISS 原则:“Keep It Simple,Stupid”。这个原则说的意思就是,尽量保持代码简单。代码简单、逻辑清晰,也就意味着易读、易维护。我们在编写代码的时候,往往也会把简单、清晰放到首位。

        思从深而行从简,真正的高手能云淡风轻地用最简单的方法解决最复杂的问题。这也是一个编程老手跟编程新手的本质区别之一。

    可复用性(reusability)

        代码的可复用性可以简单地理解为,尽量减少重复代码的编写,复用已有的代码。 

        Don't Repeat Yourself.     不要重复的代码

        比如,谈到面向对象的特性,我们会讲到继承、多态存在的目的之一,就是为了提高代码的可复用性;当讲到设计原则的时候,我们会讲到单一职责原则也跟代码的可复用性相关;当讲到重构技巧的时候,我们会讲到解耦、高内聚、模块化等都能提高代码的可复用性。可见,可复用性也是一个非常重要的代码评价标准,是很多设计原则、思想、模式等所要达到的最终效果。

    可测试性(testability)

        代码可测试性的好坏,能从侧面上非常准确地反应代码质量的好坏。代码的可测试性差,比较难写单元测试,那基本上就能说明代码设计得有问题。

    相关文章

      网友评论

          本文标题:高质量的代码

          本文链接:https://www.haomeiwen.com/subject/qunzaktx.html