Rust 学习短记:代码评审先盯住哪些细节
我以前看代码评审,只会注意缩进和命名。后来才知道,这些多半能交给cargo fmt和 clippy;真正需要花时间看的,是改动有没有改变所有权、错误和并发行为。对刚转 Rust 的我来说,一次评审不求找全问题,只求比上一次多看懂一点。
我会先问三个具体问题:这个.clone()是必要的所有权转移还是顺手复制?Result是向上传递还是被unwrap()掩盖?出现unsafe时,注释有没有说明调用方必须满足什么前提?
// SAFETY: `ptr` 来自同一个切片,且索引已检查。 unsafe fn read_byte(ptr: *const u8, index: usize) -> u8 { *ptr.add(index) }这段例子不值得照抄;它提醒我,重点是证明安全前提。没有足够理由时,优先找安全 API。
不懂的改动我会标出来,先跑cargo test和cargo clippy,再查标准库或 crate 文档。AI 可以解释脱敏后的短片段,但不能把私有代码或评审评论直接交给外部工具。提出一个准确的问题,也是一种有效的评审。
补充记录(第 10 篇):我会把这条建议落实为一个可复现的小检查,而不是停在概念层面。先写清输入、预期行为和失败时的处理方式,再在干净环境中运行最小示例;结果与假设不一致时,回到文档和代码定位原因。这样既能保留学习过程,也不会把局部经验包装成通用结论。
第 10 篇的收尾检查是:删掉无关输入,保留一个能失败的反例,并写下我准备如何确认修复是否真的生效。若没有可执行的检查,就把结论标为待验证,而不急着把它变成规则。
第 10 篇的延伸练习:把文中的判断拆成一张小表。第一列写触发条件,例如输入超过限制、依赖返回异常或调用者取消;第二列写程序可观察到的信号,例如错误类型、队列状态或测试断言;第三列写允许的处理动作,以及谁有权执行它。随后只实现其中一条最小路径,并故意制造失败输入检查结果。若失败路径没有明确输出,就不要继续增加功能。这样做虽然比让工具直接补全整段代码慢,但能迫使我先理解所有权、资源释放和调用方预期。完成后再删去不必要的分支,补上一个回归测试,并把运行命令与限制条件记在提交说明里。读者若要采用相同思路,应替换为自己的编译器版本、依赖版本和业务目标;示例不能替代项目验证。
第 10 篇还应补一个边界案例:当输入为空、依赖不可用或用户中途取消时,程序是否仍能给出可理解的结果。把这些案例写成小测试后,再检查日志是否泄露路径、账号或原始内容。只有正常路径和失败路径都能说明白,才把这段做法放进自己的工作流。
第 10 篇的发布前检查:确认标题没有承诺超出正文的范围,示例代码能独立阅读,参数没有被写成通用答案;再让一位不了解上下文的人按步骤复述风险点。如果对方无法判断何时该停止或回退,就继续删减结论、补充限制,而不是增加口号。