高质量代码

Hexiaopi大约 3 分钟

提示

什么样的代码才是高质量的代码❓

什么是高质量代码

代码质量的评价有很强的主观性，描述代码质量的词汇也有很多，比如可读性、可维护性、灵活、优雅、简洁等，这些词汇是从不同的维度去评价代码质量的。它们之间有互相作用，并不是独立的，比如，代码的可读性好、可扩展性好就意味着代码的可维护性好。代码质量高低是一个综合各种因素得到的结论。我们并不能通过单一的维度去评价一段代码的好坏。

可维护性（maintainability）

维护：无外乎就是修改bug、修改老的代码、添加新的代码之类的工作。

维护代码的时间远远大于编写代码的时间 其中：

代码易维护：在不破坏原有代码设计、不引入新的bug的情况下，能够快速地修改或者添加代码。
代码不易维护：修改或者添加代码需要冒着极大的引入新bug的风险，并且需要花费很长的时间才能完成。

可读性（readability）

可读：代码易读易理解

代码被阅读的次数远远超过被编写的次数 我们可以从以下方面来评价：

代码是否符合编码规范；
命名是否达意；
注释是否详尽；
函数是否长短合适；
模块划分是否清晰；
是否符合高内聚低耦合；

可扩展性（extensibility）

可扩展：代码应对未来需求变化的能力

开闭原则：对修改关闭，对扩展开放 评判标准：

我们在不修改或少量修改原有代码的情况，通过扩展的方式添加新的功能代码；
代码预留了一些功能扩展点，不需要因为添加一个功能而大动干戈，改动大量的原始代码；

灵活性（flexibility）

灵活：代码易扩展、易复用或者易用

举例如下：

易扩展：当我们添加一个新的功能代码的时候，原有的代码已经预留好了扩展点，我们不需要修改原有的代码，只要在扩展点上添加新的代码即可。这个时候，我们除了可以说代码易扩展，还可以说代码写得好灵活。
易复用：当我们要实现一个功能的时候，发现原有代码中，已经抽象出了很多底层可以复用的模块、类等代码，我们可以拿来直接使用。这个时候，我们除了可以说代码易复用之外，还可以说代码写得好灵活。
易用：当我们使用某组接口的时候，如果这组接口可以应对各种使用场景，满足各种不同的需求，我们除了可以说接口易用之外，还可以说这个接口设计得好灵活或者代码写得好灵活。