《代码整洁之道》读书笔记

Robert C. Martin 的《代码整洁之道》是每个程序员都应该读的经典之作。以下是我在阅读过程中的笔记和思考。

核心原则

有意义的命名

好的命名应该：

• 名副其实：名称应该说明它为什么存在、做什么事、怎么用
• 避免误导：不要用保留字、不要用缩写
• 做有意义的区分：Product 和 ProductInfo 没有区别

// Bad
const d = new Date()
const y = d.getFullYear()

// Good
const currentDate = new Date()
const currentYear = currentDate.getFullYear()

函数

• 短小：函数应该尽量短小，20 行封顶
• 只做一件事：函数应该做一件事，做好这件事，只做这一件事
• 使用描述性的名称：别害怕长名称

注释

注释不是用来弥补糟糕代码的，好的代码本身就是最好的注释。

• 好注释：法律信息、提供信息的注释、TODO
• 坏注释：多余的注释、误导性注释、日志式注释

重要的设计原则

1. 单一职责原则（SRP）：一个类应该只有一个引起它变化的原因
2. 开放封闭原则（OCP）：对扩展开放，对修改封闭
3. 依赖倒置原则（DIP）：依赖抽象，不依赖具体实现

格式化

• 垂直格式：文件不要太长，相关代码放在一起
• 水平格式：行宽不要超过 120 字符
• 缩进：保持一致的缩进风格

错误处理

• 使用异常而非错误码
• 先写 Try-Catch-Finally 语句
• 使用 unchecked 异常
• 不要返回 null，也不要传递 null

个人感悟

读完这本书，最大的收获是：写代码是一种表达，代码的读者不仅仅是计算机，更是人。我们每天花更多的时间在阅读代码而不是写代码，所以让代码易读、易懂是最重要的投资。

"任何傻瓜都能写出计算机能理解的代码。优秀的程序员写出人类能理解的代码。" — Martin Fowler

推荐指数：⭐⭐⭐⭐⭐

这本书值得反复阅读，每次都会有新的收获。