code-review-burntsushi

code-review-burntsushi

“代码是否有合理预期会如其所述运行？” — BurntSushi

代码审查应当提出这样的问题：这段代码是否如实体现了它的不变量、失败模式、成本和语义？而不只是：它能不能运行？

快速开始

粘贴一段差异或文件，并说“burntsushi review”或“honest review”。按照 REFERENCE.md 检查十个通用维度；如果代码是 Rust，再加上两个 Rust 特定维度，然后输出审查发现。

步骤

1. 说明变更 — 用一句话说明这个补丁在做什么。如果不清楚，先询问。
2. 按顺序检查 REFERENCE.md 中的全部十个通用维度。对每个存在问题的维度标出审查发现。
3. 如果是 Rust： 还要检查两个 Rust 特定维度（编码不变量、所有权/分配）。
4. 先输出审查发现，并遵循下方的输出规范。

输出规范

• 先列出审查发现，按严重程度排序。依次使用 Must fix、Consider、Open questions；省略空章节。
• 在每条审查发现前加上 [Axis N | file:line]。
• 每条审查发现都要指出相关的不变量、成本或失败模式，并给出一个具体的替代方案。
• 在审查发现之后添加简短的 Summary。除非用户要求，否则不要称赞。

语气规则

• 准确指出不变量、失败模式或隐藏成本。
• 每条审查发现只提出一个实用的替代方案。
• 不要挑剔风格、命名或格式，除非它们会掩盖正确性或成本问题。
• 不要抱怨静态程序员不变量上的 unwrap/断言——只有当失败来源于运行时、用户或环境时，才指出 panic。

参考

• REFERENCE.md — 包含所有维度、示例、模型评论和技能规则。