让代码具有可读性的10种最佳实践

18-09-19 banq
              

这是一组编写代码的10个实践,重点是提高可读性和降低复杂性。

我已经编写了20多年的代码。我与17个编写不同语言的团队合作,共建了数百个项目。这些内容包括从简单的博客站点到支持3,000个请求/秒的API,以及畅销应用程序。

根据这些经验,结合我读过的书籍,我已经确定了代码中最重要的东西:可读性。

从表面上看,可读性似乎是主观的。在语言,代码库,团队之间可能有所不同。但是当你仔细观察时,所有代码中都有核心元素使它具有可读性。许多程序员离计算机太近了,如果只看代码运行,则没有其他问题。但是离人类就太远了。

在过去的几个月里,我努力将这些元素提炼成10种编写代码的实践,重点是提高可读性和降低复杂性。不幸的是,许多人将这些视为过于琐碎。太基础了。但我向你保证,我遇到的每一段不好的代码都无法应用这些做法。每一点好的代码都可以找到这些实践中的一个(如果不是很多)。

1. 格式化
格式化可能会浪费太多精力,比如有很多标签与空格,格式虽然不是编程中的很重要部分,但是采用标准格式并让格式化能够自动化,你就可以重新专注编写代码。

2.死代码
所有那些没有注释的代码块,未使用的变量和无法访问的代码都是腐烂的。实际在表明:“没有人在关心这段代码”。因此,随着时间的推移,这些死代码将腐蚀你的代码库。这是经典的破窗理论。你必须寻找和销毁死代码。

3.嵌套代码
几乎所有代码的基础都是逻辑。通过逻辑可以进行决策,迭代和计算。常常会有逻辑分支或循环代码,从而导致深层嵌套的代码块。虽然这对于计算机执行没有什么问题,但会阻碍阅读代码者的阅读效率:代码看起来很复杂且难以理解。

4.使用对象
尽管目前面向对象编程时代,我们仍然沉浸在原始的痴迷中。我们使用长参数列表、数据块和自定义数组/字典结构,这些可以重构为对象,这不仅形式化了数据结构,而且提供了原始数据所伴随的所有重复逻辑的基础。这是OO的好处。

5. 大块代码
当你确定自己拥有大量代码时,就要随时识别,重新组合和重构这些代码。这个简单的过程能让你发现代码块的上下文和抽象级别,又能将代码正确地重构为更易读和更简单的块。

6.命名
当然,命名事情很难。有一个小技巧适用于编程:延迟命名,不要卡在命名上,只需保持不断编码。如果必须,将变量命名为句子;只需保持不断编码,我保证,当你完成功能或工作时,一个好名字将出现。

7.忽视评论
这是让我走上专注于可读性的道路,尽管我努力分享,但至少有一个人会讨厌我。你的代码别人有评论是绝对必要的,相反,如果你的代码别人没有评论可能就要重写。

8. 符合逻辑的方法返回值
你的目标应该是返回更合理的值,理想情况下,即使在空的情况下,也需要让调用者的代码能继续进行。如果确实要返回null也要用更好的方式表达。

9. 三规则
出现三次重复,就要重构了。

10. 对称
这是直接来自肯特贝克的实施模式,它简单地指出:

代码中的对称性是指在任何地方出现相同的想法。

这说起来容易做起来难。对称性体现了写作的创造性。它可能因语言、代码库到代码库以及团队而异。因此,你可以花费你的自然生命来追求它。然而,一旦开始在代码中应用对称性,就会出现一个更纯粹的形式,并且代码会很快形成。


10 practices for readable code
[该贴被banq于2018-09-20 07:53修改过]