代码可读性随想

原文： https://www.codecasts.com/blo...

本文探讨编程中的一个术语：“可读性”。

首先咱们来谈谈它的含义：

“可读性”是描述在其余开发人员没有进行太多联想或猜想的状况下就能理解代码的含义。为了让其余的开发者对你的代码“可读”，你须要谨慎选择每一个变量命名甚至是参数命名。

可是有些东西是广泛存在并且也是受到人为因素的限制的。例如，不多会有开发者去追踪命名不定的变量。

启发：变量，类，方法和其余引用是否有明确的名称？

或者从开发者自己的角度看，这些开发人员是否熟悉正在接管的项目代码？他们做为开发人员有多经验？他们是否有特定的背景使得代码对他们有或多或少的可读性？

可是咱们一般会遇到这样的应用场景：你并不知道其余开发者是谁？这在开源项目中最为广泛。

因此这就是咱们在编程中制定标准，模式和最佳实践的缘由。例如，JavaScript 代码倾向于使用 camelCase （驼峰命名），所以使用 camelCase 编写代码能够提供流畅的感受（这就能够起到可读性的做用）。了解一门语言一般使用的常见模式和风格很是重要。

补充：你所在的团队可能会制定一些本身的编程规定; 这个时候请你遵循它。

如下是能够遵循的一些简单而实用的方法：

1. 尽可能使用描述性变量名称。 更长的变量通常更具备可读性。
2. 使用空格！ 代码编译器的存在乎味着空格对于代码执行来讲是可有可无的的，可是空格对于人来讲，确实很重要！因此要利用好这一个优点。
3. 在抽象和实用性之间找到一个平衡点。 好比最简单的任务不须要 10 层重定向; 而是要从最简单的方法开始，在重构过程当中进行抽象。
4. “让代码跑起来，而后跑得对，最后跑得快。” 注意遵照这个顺序。 这将极大地帮助你提升代码的可读性，由于你首先从理解开始，而后转向性能。 这就预先创建了你的模式和语义，你更有可能以这种方式保持良好的语义化。
5. 了解你的受众。 若是你的受众不习惯内联的 lambda 计算，请不要使用它。 即便您认为这是解决问题的“最佳途径”，但还有其余一样可行的方法。
6. 遵循完善的重构和面向对象的模式。讲真， 这些概念都是前辈尝试和测试过的，你能够先不用怀疑太多，先准守它。
7. 可是！也不要盲目遵照规则。 不按期地花些时间去从新审视代码：有没有什么东西很奇怪？ 这混淆了什么么？ 这样写是否是更好？
8. 可读性高的代码不老是易于维护的，反之亦然。 可维护的代码一般是遵循良好的实践和原则创建起来的。
9. 测试对代码库维护很是重要！拥有良好的测试覆盖率使您没必要将全部代码记在您的脑海中。 （注意：测试不会一块儿消除错误，可是测试对你的帮助很是大。）

总而言之，编程是一我的为的过程。 在编写代码时遵循下面的建议:

更简单一般会更好 —海明威。