SuperAPI AI 工具集

receiving-code-review

编程与开发

查看项目

更新于 11-03 16:18

技能介绍

用途

“接收代码评审”用于在实现阶段收到代码评审意见时,指导如何严谨地处理这些反馈。它的基本立场是:评审者的反馈不一定正确,也不一定能改进代码;开发者的职责是验证,而不是表演式地表示同意。

核心原则

该技能提出一条“铁律”:在实施前严格评估建议。它列举了不应使用的回应方式,包括“你说得完全正确!”“发现得好!”“多谢指出!”“当然,我早该看到!”以及任何过度的赞美或认可,认为这类回应属于表演性质而非技术性质,浪费时间,且说明并未真正评估反馈。

处理流程

针对每条反馈,技能要求完成五个步骤:

  1. 完整阅读:读完整个评论,而不只是第一行;查看所有关联的上下文或引用;找到被讨论的具体代码。
  2. 复述需求:用自己的话复述评审者要求什么,格式为“反馈要求:〔用自己的话复述〕”。如果无法清晰复述,说明尚未理解。
  3. 对照代码库核实:检查评审者对代码的假设是否正确、该文件或函数是否如其所述那样工作、是否存在评审者可能不了解的约束。
  4. 评估技术合理性:考虑改动是否会破坏现有功能、是否符合项目模式、建议方案是否优于其他选择、有哪些取舍。
  5. 恰当回应:
    • 反馈有效时,实施后做事实性回应,例如“已修复。在第 45 行添加了空值检查。”“已实施。按建议提取了辅助函数。”“完成。测试现已覆盖边界情况。”
    • 需要澄清时,提出具体问题,例如“澄清一下:这是否适用于〔具体情形〕?”
    • 反馈错误时,基于技术理由反驳,说明原因、现有实现如何处理特定情形、建议改动会破坏什么行为。

何时反驳

技能列出应当反驳的情形:建议会破坏现有功能;评审者缺少你所掌握的上下文;建议违反项目模式;改动与已记录的需求冲突;建议增加不必要的复杂度(YAGNI);技术前提不正确。反驳时应给出技术理由和来自代码库的证据,并在适用时提出替代考虑。

处理模糊反馈

当反馈不清晰时,技能要求停止实施,先请求澄清,明确问对方是“解释 A”还是“解释 B”,不要猜测。基于误解实施会浪费时间并可能引发连锁错误。

实施顺序

收到反馈后按优先级处理:先解决阻塞性问题(测试失败、安全漏洞、功能损坏),再处理简单修正(语法、导入、拼写),最后做复杂重构(架构调整、大规模重写、模式变更)。每修一处即测试,不要批量提交。

YAGNI 过滤

对于增加未使用功能的建议,技能给出示例:评审者说“我们还应该处理情况 X”,回应可以是“情况 X 目前是必需的吗?现有用法只需要〔当前范围〕,添加 X 会为我们尚不存在的情况引入复杂度(YAGNI)。如果将来 X 变得必要,届时可以再添加。”

外部评审者

对团队之外的评审者,实施前需确认:建议对该代码库在技术上正确、实施不会破坏功能、评审者对代码的假设准确、建议符合项目模式、评审者有足够上下文。外部评审者可能不了解本地约定、历史决策、其他系统的约束以及尚未可见的近期改动。

与其他阶段的配合

该技能在代码评审周期中激活,流程为:收到代码评审 → 对每条评论依次完整阅读、复述需求、对照代码库核实、评估技术合理性、恰当回应 → 每实施一项改动后测试 → 完成后请求重新评审。

反模式

技能列出若干反模式及其正确做法:不做评估就自动同意(应逐条验证);表演式回应(应事实性说明改了什么);实施模糊反馈(应先澄清);批量实施后只测试一次(应每改一处测试一次);从不反驳(技术上合理时应反驳);无理由反驳(应给出技术原因)。

检查清单

对每条反馈逐项确认:完整阅读、用自己的话复述、对照实际代码库核实、评估技术合理性、做事实性而非表演性回应、实施后测试(如适用)。

适用场景与限制

该技能适用于实现阶段处理代码评审意见,尤其是收到团队内部或外部评审者反馈的场合。它是一套处理反馈的流程规范,不包含具体代码实现工具或自动化检查功能;其效果依赖使用者对代码库的实际了解。资料未提供该技能的具体安装方式、运行环境或收费信息。