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

更新日期: 2019-11-30阅读: 1.9k标签: 代码

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

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

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

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


1. 格式化

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


2.死代码

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


3.嵌套代码

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


4.使用对象

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


5. 大块代码

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


6.命名

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


7.忽视评论

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


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

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


9. 三规则

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


10. 对称

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

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

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

链接: https://www.fly63.com/article/detial/6660

不要浪费时间写完美代码

一个系统可以维持5年,10年,甚至20年以上,但是代码和设计模式的生命周期非常短,当对一个解决方案使用不同的方法进行迭代的时候,通常只能维持数月,数日,甚至几分钟的时间

Google内部在代码质量上的实践

良好的编程习惯涉及到很多方面,但在软件行业内,大多数的公司或组织都不会把良好的编程习惯列为主要关注点。 例如,具有可读性和可维护性的代码比编写好的测试代码或使用正确的工具更有意义,前者的意义在于可以让代码更易于理解和修改。

减少嵌套,降低代码复杂度

减少嵌套会让代码可读性更好,同时也能更容易的找出bug,开发人员可以更快的迭代,程序也会越来越稳定。简化代码,让编程更轻松!

关于 Google 发布的 JS 代码规范

Google为了那些还不熟悉代码规范的人发布了一个JS代码规范。其中列出了编写简洁易懂的代码所应该做的最佳实践。代码规范并不是一种编写正确JavaScript代码的规则,而是为了保持源代码编写模式一致的一种选择。

你解决的问题比你编写的代码更重要!

程序员似乎忘记了软件的真正目的,那就是解决现实问题。您编写的代码的目的是为了创造价值并使现有世界变得更美好,而不是满足您对自我世界应该是什么的以自我为中心的观点。有人说:如果你拥有的只是一把锤子,那么一切看起来都像钉子一样

tinymce与prism代码高亮实现及汉化的配置

TinyMCE是一个轻量级的基于浏览器的所见即所得编辑器,由JavaScript写成。它对IE6+和Firefox1.5+都有着非常良好的支持。功能方强大,并且功能配置灵活简单。另一特点是加载速度非常快的。

js函数式编程与代码执行效率

函数式编程对应的是命令式编程, 函数式编程的核心当然是对函数的运用. 而高阶函数(Higher-order)是实现函数式编程的基本要素。高阶函数可以将其他函数作为参数或者返回结果。所以JS天生就支持函数式编程

接手代码太烂,要不要辞职?

朋友发表了一条说说:入职新公司,从重构代码到放弃”,我就问他怎么了?他说,刚进一家新公司,接手代码太烂,领导让我先熟悉业务逻辑,然后去修复之前项目中遗留的bug,实在不行就重构

js高亮显示关键词_页面、搜索关键词高亮显示

页面实现关键词高亮显示:在项目期间遇到一个需求,就是搜索关键词时需要高亮显示,主要通过正则匹配来实现页面关键词高亮显示。在搜索结果中高亮显示关键词:有一组关键词数组,在数组中筛选出符合关键字的内容并将关键字高亮

写优雅的代码,做优雅的程序员

软件工程学什么? 学计算机,写程序,做软件,当程序员。听说学计算机很辛苦? 是的,IT行业加班现象严重。在计算机世界里,技术日新月异,自学能力是程序员最重要的能力之一。选了这个专业,就要时刻保持好奇心和技术嗅觉,不能只满足于完成课内作业。

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!