
柒啊
V1
2023/05/22阅读:24主题:前端之巅同款
[代码之美] 简洁代码风格终极指南
什么是“干净的代码”?
什么是“干净的代码“
-
可读 -
优雅 -
易于理解,符合单一职责原则 -
易于理解,易于修改,易于维护 -
按照测试策略进行测试
写“干净的代码”的重要性
-
解决问题更容易 -
团队中思路的交流更清晰 -
不需要过多的维护
The Best Tips to Follow
1. 使用描述性的名字
-
参数和函数的命名尽量是描述性的,不要使用简写
2. 使用 空行 去创造更可读的代码
-
空行可以增加代码的清晰度 -
空行可以轻易地明确功能结束位置(An extra line identifies where the functions end effortlessly) -
空行可以将变量的声明和操作函数分开 -
在返回值之前有一行有助于理解操作(A line before the returned value helps understand the operation)
3. 不要向函数(function)发送超过三个参数
-
使用三个参数并符合逻辑的使用他们是更清晰的 -
如果超过三个参数,则使用一个对象(object)来发送给函数,并使用相关的键(key)
4. 函数必须只执行一项任务
-
避免编写做多个事情的函数 -
两个或多个简短函数比一个复杂函数更好
5. 函数必须简短
-
如果需要一个复杂的函数,使用类(class)是更可靠的 -
如前所述,一个函数必须只做一件事,并且必须简短
6. 减少行的字符数
-
保证一个合适的代码行长度,一行的大小必须适合屏幕,以便不需要水平滚动。Prettier等许多工具都支持开发者控制其代码格式
7. 使用注释。统一注释的编写风格,注释的编写最好是名词+动词,比如数据获取、数据处理等。
8. 为提交(commit)创建描述性信息
-
使用单元测试和实践测试驱动开发 -
学习设计模式
作者介绍

柒啊
V1