先说清楚它是什么:CodeRabbit 属于「编程与开发」方向的在线服务,在 Pull Request 上自动做 AI 代码审查的服务。

这篇不讲概念,直接给能复制修改的模板,以及每个模板该怎么填。

模板怎么用

每个模板都由三部分组成:背景(你是谁、要做什么)、约束(格式、篇幅、禁止事项)、验收(怎样算合格)。把方括号里的内容换成你自己的信息即可。

模板 1:补单元测试

适合:一个缺少测试的函数或模块。

为【函数名】编写单元测试,覆盖正常输入、边界值和异常输入,使用项目现有的测试框架,不要修改被测代码。先列测试用例再写代码。

填写提示:把你最看重的一条要求放在最前面;验收看「测试能在本地通过」。

模板 2:代码审查

适合:一个 Pull Request 的改动。

审查这个改动,按「必须修改 / 建议修改 / 可以忽略」三级列出问题,每条附上文件和行号,重点关注安全、并发和错误处理。

填写提示:要求它在不确定处标注,而不是自行补全;验收看「问题定位到行」。

模板 3:小功能开发

适合:一个清晰的需求描述。

实现以下需求:【需求】。要求:先给出实现计划和要改动的文件列表,等我确认后再写代码;遵循现有代码风格;补充必要的测试。

填写提示:要求它在不确定处标注,而不是自行补全;验收看「先有计划再动手」。

模板维护

  • 给每个模板编号并记录修改日期。
  • 保留一份「效果好」的示例输出作为对照。
  • 团队共用时注明适用场景和负责人。

补充练习

读懂陌生代码库

准备材料:一个刚接手的项目仓库。

先不要改任何代码。请阅读这个仓库,输出:1)目录结构说明;2)主要模块之间的调用关系;3)本地运行步骤;4)你认为最脆弱的 3 个地方。

验收标准:运行步骤能实际跑通。

写技术文档

适用情况:手头有一个模块的源码时。

根据源码为这个模块写 README:用途、安装、最小示例、配置项表格和常见问题。示例代码必须能直接运行。

交付前确认:示例代码可运行。

修复报错

适用情况:手头有一段报错堆栈和相关代码时。

这是报错信息和相关代码。请先解释报错原因,给出最小修改方案,并说明为什么这个修改不会影响其他调用方。

检查点:修改范围足够小。

常见问题:生成的代码引用了不存在的函数

让它先搜索代码库确认 API,再写实现;运行测试验证。

常见问题:测试全绿但功能不对

人工补充关键用例,检查测试是否真正断言了结果。

常见问题:AI 改动范围过大

要求先给计划和文件清单,限定只改指定文件。

概念补充:规则文件

放在仓库里的说明文件,告诉 AI 项目约定和禁止事项。

概念补充:差异审阅

在接受 AI 修改前逐个查看 diff,是最重要的安全习惯。

适合人群:游戏开发者

游戏开发者可以用 CodeRabbit 处理原型与素材、NPC 对话与文案等工作。需要注意:关注生成素材的授权和平台对 AI 内容的披露要求。

注意事项

所有示例输出均为示意,不代表真实统计或效果承诺;请以自己的测试结果为准。

本文基于 CodeRabbit 公开的定位与通用用法编写,具体功能、套餐与可用地区以官方页面为准,产品更新后界面和名称可能变化。

延伸阅读