代码大全阅读笔记4

笔记二：实践指南——代码质量的“三大支柱”

《代码大全》并非纯理论书籍，而是给出了可落地的代码质量提升方案，核心可归纳为“三大支柱”：

1. 命名：让代码“自解释”

好的命名无需注释就能说明含义，书中提出“使用问题域术语命名”原则。例如，处理用户订单时，用“calculateOrderTotal()”而非“calcNum()”，用“userShippingAddress”而非“addr1”。这种命名方式能让任何人接手代码时，快速理解变量、函数的用途，减少沟通成本。同时明确反对“拼音+英文”“无意义缩写”等命名方式，认为这是“代码可读性的天敌”。

2. 注释：只写“为什么”，不写“是什么”

书中对注释的态度极为精准：注释不是重复代码逻辑，而是解释代码背后的设计思路。比如，一段判断“用户是否符合优惠条件”的代码，注释不该写“判断用户是否满足条件”，而应写“此处排除临时用户，因优惠仅针对正式会员（需求文档ID：PR-202305）”。这种注释能帮后续维护者理解“代码为何这么写”，尤其在业务逻辑复杂或存在特殊处理时，价值极高。

3. 错误处理：不回避“意外情况”

多数程序员容易忽略错误处理，而《代码大全》强调“错误处理与核心逻辑同等重要”。它建议：一是避免“静默失败”，比如函数执行出错时，不能只返回“false”，而要明确抛出错误信息（如“数据库连接超时：无法获取用户信息”）；二是提前预判异常，比如接收用户输入时，先验证格式、范围，而非等程序崩溃后再调试。这种“防御性编程”思维，能大幅提升系统的稳定性。