什么是高质量的代码

学习并整理一下个人的理解：什么样的代码是高质量的代码？

代码的评价指标

KISS原则：“Keep It Simple，Stupid”

我们需要通过尽可能简单的代码来完成目标，避免炫技地引入复杂的结构和设计模式。

典型的反例就是Java，完全的面向对象导致了代码架构的过度复杂化。例如程序员需要点一杯咖啡，Java 风格的代码如下

1	CoffeeFactoryBuilderSingletonManagerProvider.getCoffeeFactoryBuilderSingleton().getCoffeeBuilder().addMilk().addSugar().build();

当然了，单纯的批判也是不对的，这种复杂设计和规范对于项目的可维护性还是很有必要的，它可以保证不同的Java码农产出同一套风格的代码。（与之不同的是，C++程序员在实现同一套逻辑时可以给出 N 种风格的代码）

Any fool can write code that a computer can understand. Good programmers write code that humans can understand.

我们需要编写提供易读、易理解的代码，让机器理解代码是容易的，困难的是让其他人也容易读懂代码，这方面有很多细节需要考虑：

没有人喜欢在代码中加上没什么用的注释，但是又不得不加上一点，就好像打扫厕所——都不想干这个活，但是它确实有用。

有几条关于注释的建议：

当然，有时候为了程序的性能提升也可以牺牲一部分代码可读性：代码丑到这个样子，性能一定快到飞起吧！

DRY原则：“Don't Repeat Yourself”

我们需要在代码中尽量减少重复片段的编写，复用已有的代码是更好的选择。如果代码中存在多处重复片段，不仅仅是代码量太大，还意味着改动时必须同步更改所有位置，否则很容易导致问题。

可扩展性表示代码应对未来需求变化的能力，对于具有可扩展性的代码，我们可以在不修改或少量修改原有代码的情况下，通过扩展的方式添加新的功能。更简单地说，代码自身已经预留了一些功能扩展点，我们可以把新功能代码直接插到扩展点上，而不需要因为要添加一个功能而大动干戈地改动大量的原始代码。

对代码的维护主要是修改bug、修改旧代码、添加新代码等。可维护性的直观含义为：

可维护性通常可以由前面的几个指标保证，例如可读性、可复用性、可扩展性等，有时还需要加上可测试性：代码本身是充分解耦的，使我们容易编写单元测试。

对于一个分支判断过于复杂的函数，使用“卫语句”是一个很好的习惯：优先检测非法情况，对于非法情况提前返回，避免把函数的主要部分放在多层if语句中。

在编程中，除了保持一些良好的编程习惯，更重要的是不要过早地对代码进行一些“自以为是”的优化，需要写出对人类，对编译器都友好的代码。对于大部分的简单情况，编译器在了解了代码的意图时会自行进行相关优化。只有在完成了主体功能，经过测试找到性能瓶颈之后，手动进行的针对性优化才是有意义的。

优化的前置步骤是性能测试，优化的目标代码是性能瓶颈部分，对于细枝末节的优化并不会产生显然的性能提升，反而可能增加出错的风险。

在编程中，参数的合法性检查到底是调用者负责，还是由被调用者负责？通常有如下几种做法：

命名风格通常有大驼峰，小驼峰，下划线（蛇形）三种，使用类型缩写作为前缀的匈牙利命名法已经过时了。
某些语言严格规定了命名风格，遵循规定即可。
有时为了和语言的标准库/内置函数区分，也可以反其道行之，使用另一种风格进行命名。
变量名应清晰描述变量的含义，大范围生效的变量应避免使用 a, b, c, i, j, k 等无语义名称，小范围或者循环变量则可以接受（没办法，科学计算如果每一个变量名称都很长，计算公式就过于复杂了）
布尔变量通常以 is_、has_、should_ 开头，不要以否定形式命名，否则逻辑有点绕。
函数名称通常是动名词形式，类的名称通常是名称形式，类的方法与函数的要求相同。
常量通常使用全大写加下划线的形式，即使某些语言（python，MATLAB）没有直接支持常量（除非使用额外的封装技巧），也最好遵循这个习惯。

什么样的代码是好的？这可能很难回答，但是不妨反过来思考——什么样的代码是糟糕的？这个问题的答案至少包括：