聊聊代码的整洁（下）

整洁代码之道摘要

这篇文章讨论了如何编写整洁的代码，包括注释、代码格式、类和系统层面的整洁，并提供了处理代码坏味道的治理清单。

Part4 注释

注释应仅用于必要时，如法律信息、解释意图、外部代码解释、警告风险、未来的TODO事项以及公共API说明。糟糕的注释（如只给自己看、多余言语、变更日志等）应避免，以减少误导和混淆。

Part5 良好的代码格式

清晰的代码格式促进开发者间沟通，提高代码的可维护性。推荐的格式技巧包括控制源代码文件长度、逻辑分层、空行分隔、变量声明位置、代码宽度、缩进格式等。团队应统一代码风格规则。

Part6 类

类应简洁且符合单一权责原则。类名应准确描述其职责，类的方法应操作类的实体变量以保持内聚性。类的设计应对扩展开放、对修改封闭。

Part7 在系统层级上保持整洁

系统应清晰表达意图，区分构造与执行逻辑。Kent Beck提出的简单设计原则包括运行所有测试、消除重复、增强表达力以及减少类和方法数量。并发编程应单独处理，以避免死锁和其他并发问题。

Part8 代码坏味道的治理清单

整理了代码坏味道的清单，建议删除无关注释、简化编译构建过程、优化函数参数、使用描述性名称、避免混淆、埋葬“死代码”、解耦模块、遵循最小惊异原则等。

总结：程序员不应仅满足于让代码工作，保持代码的整洁性至关重要。及时清理混乱，避免代码腐化。