代码整洁之道：坏味道与改进策略

"《代码整洁之道》是一本探讨如何通过识别和修复代码中的不良实践，提升代码质量的书籍。书中提出了各种代码坏味道，并提供了相应的解决策略，旨在提高代码的可读性和可维护性。以下是对书中部分观点的总结： 1. 注释问题： - C1 不恰当的注释：不应将注释与源代码混杂，应将其保存到版本控制系统。 - C2 废弃的注释：过时的注释应当及时删除。 - C3 冗余注释：注释应补充代码无法明确表达的信息，避免重复。 - C4 糟糕的注释：注释需清晰准确，否则不如不写。 - C5 注释掉的代码：应当删除不再使用的代码，而非仅仅注释。 2. 构建与测试环境： - E1 多步构建：构建过程应简化为单步操作，以提高效率。 - E2 多步测试：单元测试应能一键执行，方便快速验证代码。 3. 函数设计： - F1 过多的参数：函数参数应尽量少，避免超过三个。 - F2 输出参数：尽量避免使用，以增强代码的直接性。 - F3 标识参数：布尔参数可能导致混乱，考虑重构以消除它们。 - F4 死函数：不被调用的函数应予删除，以减少冗余。 4. 一般性问题： - G1 多语言源文件：尽量保持源文件语言的一致性。 - G2 明显的行为未实现：遵循“最少惊异原则”，函数应按预期工作。 - G3 不正确的边界行为：确保代码对所有边界条件的处理是正确的。 - G4 忽视安全：编写安全的代码，预防潜在问题。 - G5 重复代码：消除重复，利用设计模式提高复用性。 - G6 错误的抽象层级：确保代码在正确的抽象层面上。 - G7 基类依赖于派生类：基类应独立于派生类，保持松耦合。 - G8 信息过多：减少类的方法和变量数量，提高封装。 - G9 死代码：删除未被调用的代码以减小体积。 - G10 垂直分隔：变量和函数定义靠近使用处，提高可读性。 - G11 前后不一致：保持函数参数一致性，便于理解。 - G12 混淆视听：清理无用的元素，保持代码清晰。 - G13 人为耦合：避免不必要的相互依赖。 - G14 特性依恋：类应专注于自己的职责，减少对外部的依赖。 - G15 选择算子参数：避免布尔参数，利用多态实现更清晰的接口。 - G16 晦涩的意图：代码应表达清晰，优先考虑易读性。 - G17 位置错误的权责：根据“最少惊异原则”，将代码放置在符合逻辑的位置。 - G18 不恰当的静态方法：静态方法的使用需谨慎，避免破坏封装或导致意外依赖。 这些观点和实践有助于提升代码的整洁度，从而提高代码的可读性、可维护性和团队协作效率。遵循这些原则，可以创建出更高质量的软件产品。"