如何寫出易于理解的干凈代碼?
为什么要写干净的代码? ⛩️
想象一下你在一间杂乱的房间里寻找东西——你会浪费很多时间来找,是这样的吧?
代码混乱也是一样!找到问题或理解发生了什么更困难。干净的代码可以避免这种混乱,让你更轻松地理解和调试代码。
你知道吗?比如说……编写干净的代码,你将会省下其他开发人员宝贵的时间。相信我,你其实是在拯救世界!就像超级英雄一样!🦸
zh: (此处省略)
编写干净代码的7个技巧🧯
1. 给变量起有意义的名字
当你创建一个 variable
或 function
的时候,给它起一个能反映 它做什么 的名字。
想一想,如果你在电脑上命名一个文件夹的话,不要叫它 b
,而是叫它 numberOfUsers
。这样你就不用再写额外的注释来说明 b
是什么了。
例子 :
let 用户人数 = 5;
// 清晰易懂,便于理解
切换到全屏模式,退出全屏
我们来遵守单一职责原则(SRP),
一个函数应该做一件事并把它做好。
这样更容易理解,需要时也方便修复。就像用一个工具干一件事情,比如用铅笔来写字,用剪刀来剪纸。
例子 :
//下面是一个添加两个数字的函数定义:
function addNumbers(a, b) {
//函数 addNumbers 接收两个参数 a 和 b,返回它们的和
return a + b;
}
进入全屏 退出全屏
这个函数只做加法,别的什么都不做。
3. 避免不必要的备注
不要到处添加注释,试着让代码更具自说明性,通过使用有意义的名字。
😕🤬 仅在内容 棘手 或需要特别说明时添加注释,过多的注释会让人们感到困惑。
例子 :
// Good: 清晰的名称,不需要额外的注释
let userAge = 25;
// Bad: 不清楚的命名,需要一个注释
let a; // 用户的年龄
切换到全屏模式,退出全屏
让你的代码易于阅读
使用 空格 , 缩进 ,和 换行 来帮助你的代码保持整洁哦。
就像写一段文字一样,你应该把代码分成更小的部分,不要把代码写成一行。
示例,
// 好的代码
if (isLoggedIn) {
console.log("欢迎!");
} else {
console.log("请登录。");
}
// 差的代码
if(isLoggedIn){console.log("欢迎!");}else{console.log("请登录。");}
全屏查看 关闭全屏
5. 写写单元测试
单元测试就是给你的代码做个健康检查。
他们确保一切按应有的方式正常运行。当你修改代码时,这些测试会告诉你哪里出了问题。
例子:
function add(a, b) {
return a + b;
}
// 测试一下
console.assert(add(2, 3) === 5, '测试失败: 2 + 3 应该为 5');
全屏 / 退出全屏
6. 小心依赖关系
在构建软件时,尽量让各部分独立,避免相互依赖过重。
比如说,洗碗机不仅限于一个特定的厨房,可以在任何厨房使用。这样管理起来会更方便。
7. 整理您的项目
把文件和文件夹整理好,就像保持桌面整洁一样。这样一来,在项目变大时能更轻松地找到东西。
zh:例如:
- 在项目中使用诸如
components
,services
和utils
这样的文件夹。 - 把相似的文件放在一起,这样找起来方便。
✅ 建议
用这个可打印的后端开发人员Notion模板来跟踪你的进度! 🔥
初学者开发者常常在选择合适的技术组合上感到困难,这让他们白白浪费时间并失去动力。
因此,我创建了一个设计精美且非常易于遵循的6个月后端开发路线图,并在Notion里制作,让你可以轻松跟踪进度并轻松实现目标!
此路线图如下:
- 🛤️ 提供清晰路径以避免混淆。
- 🎯 通过设定起点和终点来帮助你保持动力。
- 📚 遵循结构化的学习计划,类似于学校的课程大纲。
- 📅 通过设定每周学习目标来组织你的学习,这些目标覆盖工具和语言。
- ⏳ 确保在6个月内完成所有必需的内容。
- 👀 具有优雅的设计,使导航更加简单。
zh: * (此处省略)
结尾 🏁
编写干净的代码就像给房子打下坚实的基础一样。它让一切都井井有条,使得添加新功能或解决遇到的问题都变得更加简单而不费力。
遵循以下7个技巧:让你的代码变得简洁、易读且易于合作!
了解更多: 如何在6个月内成为后端开发工程师的技能路线图
共同學(xué)習(xí),寫下你的評論
評論加載中...
作者其他優(yōu)質(zhì)文章