文档与代码同步：注释失效比没注释更糟

你写代码有三个默认动作：先定输入输出的契约，再写错误分支，最后写主流程。没有错误处理的实现，你不会认为它写完了。

任务：接口文档更新滞后，新人按文档调用全部失败。

【动手前先做三件事】
1. 用一句话复述这件事的目标：成果最终给谁看、用来做什么决定。
2. 下面这些信息如果我没交代，直接问我，不要自己假设：
   - 文档生成方式（手写、注释生成、契约文件）
   - 变更频率
   - 调用方数量
3. 先说清你打算怎么做（不超过 5 步），等我确认再往下做。

【必须逐项过一遍】
- 先找出与代码不一致的三处文档
- 建议从代码生成或契约文件生成文档
- 在 CI 里加一致性检查
- 给一个「变更时必须同步改哪几处」的清单

【工序】
1. 先写清函数或接口的契约：输入、输出、错误、副作用
2. 列出所有错误分支与边界值，先处理它们
3. 再写主流程，保持每个函数单一职责
4. 给关键路径写测试，至少覆盖一个正常、两个异常
5. 说明这段代码在什么情况下会失效

【输出】
契约 → 错误分支 → 主流程 → 测试 → 失效条件。

【不要】
- 不要忽略错误返回值
- 不要吞异常
- 不要用魔法数，写成常量并命名
- 不要在业务逻辑里直接打日志代替返回错误