更好、更简洁的代码的 6 个原则

2025-05-28

更好、更简洁的代码的 6 个原则

糟糕的代码直到2000年仍然有效。糟糕的代码难以理解,过于复杂,难以测试,并且会让其他开发人员感到沮丧。虽然短期内编写干净的代码可能需要更长的时间,但编写干净的代码可以节省每个人的时间、精力,最终节省金钱,这一点毋庸置疑。

代码审查

但总有学习的空间。没有人从一开始就能写出干净的代码。以下是保持代码整洁的六条最重要的原则。

(附注:干净的代码不依赖于特定于语言的规则。相反,它依赖于开发者社区商定的与语言无关的原则。因此,这些原则适用于几乎所有编程语言)

清洁代码原则

KISS:保持简单,愚蠢。这是一条源自美国海军的设计原则,可以追溯到 1960 年。它指出,大多数系统应该尽可能保持简单(但并非更简单,正如爱因斯坦所说)。应该避免不必要的复杂性。编写代码时要问的问题是:“这能用更简单的方式编写吗?”

DRY:不要重复自己。与 KISS 和极简主义设计哲学密切相关。它指出,每条知识(在本例中为代码)在系统(代码库)中都必须具有单一、明确、权威的表示。违反 DRY 原则的行为被称为 WET:我们享受打字,每件事都写两遍,浪费每个人的时间。

YAGNI:你不会需要它。除非必要,否则开发人员不应添加功能。YAGNI 是极限编程 (XP) 方法论的一部分,旨在提高软件质量并提高对客户需求的响应速度。YAGNI 应与持续重构、单元测试和集成结合使用。

组合优于继承:很遗憾,这不是一个缩写词。这是一个原则,设计类型时,应该考虑它们的作用,而不是它们本身。这个视频对此进行了更详细的解释。实现此原则的方法之一是使用Object.assign()ES6 中的方法。

许多开发人员更喜欢组合而不是继承,因为继承迫使您在项目早期构建对象分类,从而使您的代码在以后的更改中变得不灵活。

优先考虑可读性:机器能读懂你的代码,并不意味着其他人也能读懂。尤其是在多人合作开发项目时,务必优先考虑可读性而非简洁性。如果别人无法理解,那么代码再简洁也没意义。

有很多方法可以提高代码的可读性。例如,将常用数字放入命名良好的常量中(例如const CACHE_TIME = 200;),以及创建长名称而不是短名称(例如userHasFormAccessover canAccess,因为它的含义不多)。

实践一致性:这可以说是所有整洁代码原则的首要原则。如果你决定以某种方式做某事,请在整个项目中坚持下去。如果你不得不改变最初的选择,请在评论中解释原因。


当然,这绝不是一份详尽的清单。关于代码整洁,还有很多内容。事实上,如果你想读一本关于代码整洁的优秀书籍,我推荐D. Boswell 和 T. Foucher 合著的《易读代码的艺术》 。

您最喜欢哪些干净代码原则?

文章来源:https://dev.to/x-team/6-principles-to-for-better-cleaner-code-1j1j
PREV
这 10 个直播频道将帮助你成为更好的程序员
NEXT
14 个 VSCode 扩展将提高你的工作效率