如何编写干净的代码

为什么要编写干净的代码？ ⛩️

想象一下，如果您试图在凌乱的房间里找到某样东西，您会浪费时间寻找，对吧？

混乱代码也是如此！发现问题或了解正在发生的事情更加困难。使用干净的代码，您可以避免这种混乱。

你知道吗？..通过编写干净的代码，您还可以节省其他开发人员宝贵的时间。相信我...你正在拯救世界！ ？

---

编写简洁代码的 7 个技巧？

1.使用有意义的名字

创建变量或函数时，为其指定一个名称，以告诉它的作用。

将其想象为命名计算机上的文件夹。不要将其称为 b，而是将其称为 numberOfUsers。这样，您就不需要额外的注释来解释 b 是什么。

示例：

let numberOfUsers = 5; // Clear and easy to understand

2.遵循单一职责原则（SRP）

一个函数应该做一项工作并且做得很好。

这使得在需要时更容易理解和修复。这就像拥有一种工具来完成一项任务，就像一支用于书写的铅笔和用于切割的剪刀。

示例：

function addNumbers(a, b) {
    return a + b;
}

此函数仅将两个数字相加。它没有做任何其他事情。

3. 避免不必要的评论

不要到处添加注释，而是尝试使用好名字来让你的代码不言自明。

仅当某些事情棘手或需要特殊说明时才使用注释。太多的评论会让人们感到困惑。 ??

示例：

// Good: Clear name, no extra comment needed
let userAge = 25; 

// Bad: Unclear name, needs a comment
let a; // age of the user

4. 让你的代码可读

使用空格、缩进和换行符来保持代码整洁。

就像写一个段落一样，您应该将代码分成更小的部分，这样它就不会全部在一行中。

示例：

// Good Code
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Bad Code
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

5. 编写单元测试

单元测试是对代码的检查。

他们确保一切正常运转。当您更改代码时，这些测试会告诉您是否有问题。

示例：

function add(a, b) {
    return a + b;
}

// Test
console.assert(add(2, 3) === 5, 'Test failed: 2 + 3 should be 5');

6. 小心依赖关系

当你构建软件时，尽量将各个部分分开，这样它们就不会过度依赖彼此。

例如，洗碗机可以位于任何厨房，而不仅仅是一个特定的厨房。这样管理起来更容易。

7. 组织你的项目

让您的文件和文件夹井井有条，就像保持办公桌清洁一样。当您的项目变大时，这可以让您更轻松地找到东西。

示例：

• 在项目中使用组件、服务和实用程序等文件夹。
• 将相似的文件放在一起，以便您知道在哪里查找它们。

✅ 推荐

使用此可打印后端开发人员概念模板来跟踪您的进度！ ？

初学者开发人员经常难以选择正确的技术堆栈，这导致他们浪费时间并失去动力。

因此，我在 Notion 中创建了一个设计精美、非常易于遵循的 6 个月后端开发人员路线图，以便您可以跟踪您的进度并轻松坚持您的目标！

此路线图：

• ?️ 提供清晰的路径以避免混乱。
• ？概述从哪里开始和结束，帮助您保持动力。
• ？遵循类似于学校教学大纲的结构化计划。
• ？通过工具和语言的每周目标来组织您的学习。
• ⏳ 确保在 6 个月内完成，涵盖您需要的一切。
• ？具有精美的设计，方便导航。

---

结论 ？

编写干净的代码就像为房子打下坚实的地基。它使一切井井有条，可以轻松添加新内容或修复问题，而不会遇到太多麻烦。

遵循这 7 个技巧，让您的代码简单、可读且易于使用！

阅读更多： 6 个月内成为后端开发人员的技能（路线图）

以上是如何编写干净的代码的详细内容。更多信息请关注PHP中文网其他相关文章！