《clean code》的读书总结｜搬运转载

一、整洁代码

1. 代码正确
2. 简洁明了
3. 清晰易读
4. 短小精确

---

二、命名

1.准确

• 名字与意义匹配
• 易于区别

2.实用

• 使用读的出来的名称
• 使用可搜索的名称

3.明确

• 一个概念对应一个词
• 不用双关语
• 使用有意义的语境

---

三、函数

• 短小
• 职责单一
• 一块代码中，函数的抽象层级需一致
• 函数命名规范（参照二）
• 参数尽可能少
• 如果函数需要的参数要求数量有多种，应考虑将其封装成类
• 实用异常类代替返回错误码，抽离try/catch代码块，使代码更加简洁

---

四、注释
1.少用注释，尽可能通过规范的代码来表达
2.不使用无意义的注释
3.必要的注释：

• 法律信息
• 提供信息的注释
• 对代码意图进行解释的注释
• 警示信息，防止踩坑
• TODO注释：未来得及完成的部分

4.对于无用的代码应直接删除而不是注释

---

版权声明：本文为CSDN博主「MummyDing」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/mummyding/article/details/51326238