如何编写干净的代码:重构和最佳实践。

2025-05-25

如何编写干净的代码:重构和最佳实践。

我们都经历过这种情况——盯着应该能用的代码,却发现它几乎无法阅读。说实话:每个开发者(是的,我们每个人)都写过类似的代码。好消息是?重构是一项可以学习的技能,编写简洁的代码也并非遥不可及。

因此,让我们深入探讨编写干净代码的真正含义——不是抽象的“只要整洁”类型的干净代码,而是可读、可维护,而且我敢说,几乎是漂亮的代码。

1/ 按照你想要的意思命名
整洁的代码从清晰的命名开始。Not x,,tempdata​​。你的变量和函数需要讲述一个故事。

例子:

图片描述

2/ 少即是多:函数大小的力量
你见过像小说一样长的函数吗?说实话,长函数很痛苦。简洁的代码依赖于小巧、单一用途的函数。把每个函数想象成一个构建块:它应该只负责一项任务,并且应该出色地完成它。

例子:

图片描述

3/ 一致性是关键
想想看:如果你调用一个数组userList,就不要调用下一个数组users。一致的命名、缩进和格式可以节省每个人的时间,因为它们创建了一种模式——一种节奏——使代码变得可预测。

例子:

图片描述

4/ 有目的的注释,而不是出于习惯
注释很棒,但前提是它们能提升清晰度。如果你的代码很简洁,就不需要那么多注释。而且,对于你添加的注释,一定要让它们有价值。

例子:

图片描述

5/ 魔法数字和硬编码值——摆脱它们
如果你到处都硬编码,以后会很麻烦。相反,使用常量来使这些数字有意义。

例子:

图片描述

6/ DRY:不要重复自己
。重复的代码是维护的噩梦。与其复制粘贴,不如找到一种方法来编写可重用的函数或模块来处理重复的逻辑。

例子:

图片描述

7/ 保持代码的 SOLID
原则(单一职责、开放-封闭、里氏替换、接口隔离和依赖倒置)听起来像是企业流行语,但它们对于编写简洁的代码却出奇地实用。如果您不熟悉这些原则,请从单一职责原则开始:每个类或函数都应该只负责一项职责。

例子:

图片描述

8/ 彻底重构
重构并非一次性的事情,而是一种思维模式。每次审查代码时,都要寻找可以改进的地方。重构的关键在于认识到代码很少能在第一次就完美无缺。不要害怕不断修改,直到它们真正变得清晰为止。

例子:

图片描述

如果您能掌握这些基本知识,那么您已经遥遥领先了。

文章来源:https://dev.to/balrajola/how-to-write-clean-code-refactoring-and-best-practices-1mo
PREV
提升你的效率:开发团队的 5 大生产力插件🔥🔥🔥
NEXT
10 个你希望早点知道的 Git 命令