【翻译】代码简洁之道

最近看到一篇文章，介绍了简洁代码的重要性以及我们要如何编写简洁的代码，粗略翻译后记录如下。

什么是简洁代码？

以下是简洁代码的特点：
1.必须要具有可读性；
2.必须是优雅的；
3.必须易于理解并且遵循单一责任原则；
4.必须易于修改和维护；
5.必须按照测试策略运行测试。

简洁代码的重要性

下面是一些编写简洁代码的优点：
1.解决问题变得更容易
干净的代码可以从根本上解决问题，软件设计和算法也变得更具有意向性、更优雅。

2.清晰的思想交流
干净的代码减少了团队开发人员之间发生误解和争执的可能性，最终减少 bug 的出现。

3.减少代码维护；
干净的代码更易于阅读和理解，所以不必花很多时间在理解这些函数代码上面，为更新、修改和扩展代码留出更多时间。

编写简洁代码的八个技巧

1.使用描述性名称；

函数或变量的名称应该尽可能具有描述性，函数名称应该以动词开头，例如，一个返回开发者名字的函数，应命名为getDeveloperName，而不是直接用name命名。

2.适当使用空白行编写更具可读性的代码；

使用空白行的优点如下：
①增加代码的清晰度；
②一条额外的空白行可以明确地指明函数结束的位置；
③空白行可以将变量声明和操作函数分隔开；
④返回值之前的一行有助于理解该操作；

3.一个函数中不得超过三个以上的参数；

在函数中使用一组参数，很难找到它们的使用位置。相反，只使用三个参数并在函数中遵循它们的逻辑是更有效的，并使代码变得清晰。
如果需要使用三个以上的参数，可以改为传一个对象到函数，并使用相关的键名调用

4.一个函数只执行一个任务；

开发者应该避免在一个函数中做很多件事情，一个模块内只能执行一个任务，有两个或更多的短函数也比一个复杂的函数要好得多。

5.函数必须简短；

如果需要一个复杂的函数，那么使用类更合理一些。函数必须只做一件事情，正如前面提到的，而且必须是简短的。

6.减少一行中的字符数；

避免一行代码过长，这样方便阅读。行的长度必须适应屏幕，这样就不需要水平滚动。许多代码开发工具都可以格式化代码让代码便于阅读。

7.使用注释

使用注释可以帮助维护代码，虽然描述性的函数名称和变量名称也可以避免写注释，但是并不推荐这样做。注释可以使代码更清晰和连贯。

8.commit 时记录描述性信息

提交代码时记录一条描述性消息对于将来理解代码的功能是有帮助的，应尽可能提供详细的描述。