掌握干净代码的艺术：每个开发人员都应该知道的基本原则（以及一些模因）

作为开发人员，我们可以培养的最重要技能之一就是编写干净的代码。干净的代码不仅仅是为了让事情正常运转，它还可以让您的代码随着时间的推移变得易于阅读、理解和修改。编写干净的代码可以减少错误、改善协作并提高软件质量。**以下是一些需要遵循的基本原则的细分：**

**可读性：清晰度优先于聪明度**

整洁代码的第一条规则是可读性。您的代码应该清晰明了。如果其他人（甚至是未来的您）需要使用它，他们应该能够快速理解它，而无需解读复杂的逻辑。这包括清晰一致的格式、缩进和间距。

**简单：避免过度设计**

不要把事情搞得太复杂。KISS（保持简单）原则是你的良师益友。简单的代码更易于维护和扩展。将复杂的任务分解为更小、更易于管理的部分，并专注于一次解决一个问题。避免编写目前不需要的功能。

**有意义的命名约定**

名称很重要。为变量、函数和类选择有意义的名称将为您的团队避免很多困惑。命名良好的函数或变量可让您的代码的用途一目了然。避免使用 temp、data 或 foo 等通用名称。相反，请使用 calculateTotalPrice() 或 userAuthenticationData 等描述性术语。

**一致的结构**

一致性是代码整洁的关键。采用一种格式标准并坚持下去。例如，决定如何命名文件、构建目录或格式化注释。一致性可以帮助其他人更快地理解您的代码，并减少协作项目时的摩擦。它还可以让你更容易发现错误或意外行为。

**重构：保持新鲜**

定期重构。代码库会随着时间的推移而恶化，出现未使用的功能、重复的代码或过于复杂的方法。留出时间进行重构以改进结构而不改变功能。清洁代码是一个持续的过程，而不是一次性的努力。

**明智地使用评论**

干净的代码不需要过多的注释。但是，如果代码的某个部分很复杂或者包含不明显的业务逻辑，请使用注释。注释应该解释为什么以某种方式执行某些操作，而不是代码正在执行的操作 — 从命名约定和逻辑中应该已经可以清楚地看出这一点。

**遵循 DRY 原则（不要重复自己）**

重复代码是一种坏习惯，会导致维护困难。相反，可重用的代码应该封装到函数、类或模块中。这可以减少出现错误的机会，并使代码更易于维护和扩展。

**整洁代码是一种心态**

编写干净的代码不仅仅是一项技能，而是一种心态。它需要纪律、持续改进的承诺以及对清晰度和简单性的关注。通过采用干净的代码原则，您将构建经得起时间考验、更易于维护且可以轻松扩展的软件。

在开展下一个 Web 项目时，请记住：少即是多。花点时间编写干净、易懂的代码，好处自然会随之而来。