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

来源:http://www.chinese-glasses.com 作者:Web前端 人气:171 发布时间:2020-03-15
摘要:时间: 2019-11-30阅读: 148标签: 代码 时间: 2019-08-13阅读: 322标签: 经验 这是一组编写代码的10个实践,重点是提高可读性和降低复杂性。我已经编写了20多年的代码。我与17个编写不同语言的

时间: 2019-11-30阅读: 148标签: 代码

时间: 2019-08-13阅读: 322标签: 经验

这是一组编写代码的10个实践,重点是提高可读性和降低复杂性。我已经编写了20多年的代码。我与17个编写不同语言的团队合作,共建了数百个项目。这些内容包括从简单的博客站点到支持3,000个请求/秒的API,以及畅销应用程序。

这是一篇值得收藏起来,隔三差五就拿来重读的文章!因为作者向你保证,他“遇到的所有糟糕的代码,都是因为没采纳这些实践经验。而任何一段优秀的代码,都采纳了至少部分实践经验。”

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

还等什么?赶快看看这些经验就是什么吧?

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

我已经写了20年代码了,在此期间曾与17个团队共事过,使用不同的语言做过数百个项目。

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

这些项目从最简单的博客网站,到支持每秒3000多次请求的API,还有曾经热卖过的应用。

  1. 格式化

根据这些经验,再结合我读过的书,我认为编程中最重要的是:# 可读性。#

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

可读性

2.死代码

表面上看来,可读性似乎很主观。不同语言、代码、和团队对于可读性的定义不尽相同。但如果深入本质的话,就会发现代码可读性有一些非常关键的因素。

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

许多程序员太倾向于计算机了,只要程序能运行就一了百了。尽管是老生常谈,但这种方式完全断绝了人参与的可能性。

3.嵌套代码

最近几个月, 我在努力将这些人为因素提炼成11条写程序的实践经验,专门讨论如何增强可读性并降低复杂度。

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

我在BaseCode中写过这些详细内容,并将其应用到真实世界的代码片段中。

4.使用对象

许多人会认为这些太基础、无关紧要,可以忽视。但我可以向你保证,我遇到的所有糟糕的代码都是因为没采纳这些实践经验。而任何一段优秀的代码都采纳了至少部分实践经验。

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

格式

  1. 大块代码

我们在格式上消耗了太多精力。制表符还是空格,Allman还是KR。总会有一天,你会意识到格式在编程中并不是最重要的。

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

选择一种格式,应用到代码中,然后将这个过程自动化。然后就可以重新专注于写代码本身了。

6.命名

死代码

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

所有注释掉的代码块、未使用的变量和无法到达的的代码都是垃圾。他们就像在对读者说,“我不关心这段代码”。

7.忽视评论

于是恶性循环开始了。日复一日,死代码最终会埋葬你的代码。这正是经典的破窗效应。

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

必须要找出并干掉死代码。虽然不需要把精力主要放在这里,但一定要时时留意。

  1. 符合逻辑的方法返回值

10bet,嵌套代码

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

逻辑几乎是一切代码的基础。我们写代码是为了做决策、迭代和计算。一般情况下都会导致分支或嵌套,从而造成嵌套得很深的代码块。

  1. 三规则

虽然计算机很容易阅读这种代码,但对于人类则是非常大的精神负担。因此,代码会变得复杂、难以阅读。应该通过防御语句、提前返回或使用函数式编程等方式消灭嵌套代码。

出现三次重复,就要重构了。

使用对象

  1. 对称

尽管现在是面向对象编程的时代,我们依然使用了过多的原始指令。

本文由10bet发布于Web前端,转载请注明出处:让代码具有可读性的10种最佳实践

关键词:

上一篇:10betvue-contextmenujs原生右键菜单组件

下一篇:没有了

最火资讯