What Is Readable Code

What Is Readable Code?

分享的这篇文章是关于代码可读性的设计和使用的知识

Code creates interfaces. But code itself is also an interface.
代码创建接口。 但代码本身也是一个接口。

首先介绍了可读性是多少？

从三个方面介绍可读性

• 代码看起来漂亮时是否可读？ 看起来漂亮是可读性的一个很好的副作用，但它并没有那么有用
• 代码在生成较少错误时是否可读？ 阅读都无法召唤出错误
• 当编辑更容易时代码是否可读？ 可读代码应该易于安全的编辑

从上面的三个问题分析出可读代码应该易于安全的编辑， 但是什么可以使代码更容易编辑？

有一条规则是

Code is easier to edit when the variable names are expressive
当变量名称具有表现力时，代码更容易编辑

从这里就可以简单的把从代码的可读性转变成代码容易编辑的道路上

下面列举了几个例子，是在需要修改/创建接口：

• 用户想要添加新功能。要做到这一点，他们必须找到正确的位置并添加功能，而不添加错误。
• 用户想要修复错误。他们需要找到错误的来源并编辑代码，即使它停止发生，而不会引入不同的错误。
• 用户想要验证边缘情况以某种方式起作用。他们想要找到合适的代码，然后通过逻辑来模拟将要发生的事情。

大多数改名接口的情况都有类似的模式。

有了一个生成和定制它们的过程：

• 用户可以轻松找到此代码吗？ 对于不相关的功能是否会使搜索结果混乱？
• 一旦找到，用户是否可以快速确认代码的当前行为？
• 用户是否可以依靠机器验证来安全地编辑或重用此代码？

简而言之，可读代码必须是可用的。 也许作为副作用，它看起来也很漂亮。