CodeRabbit 相关术语解释(新手向)
先说清楚它是什么:CodeRabbit 属于「编程与开发」方向的在线服务,在 Pull Request 上自动做 AI 代码审查的服务。
看文档和设置项时遇到的术语,这里用一两句话解释清楚。
术语表
- 补全(Completion):在光标处预测下一段代码,速度快但上下文有限。
- 编程智能体:能读写多个文件、运行命令并迭代修复的 AI,需要控制权限。
- 上下文索引:把代码库建立索引,让 AI 回答时能引用相关文件。
- 规则文件:放在仓库里的说明文件,告诉 AI 项目约定和禁止事项。
- MCP:让编程工具连接外部数据和工具的协议。
- 差异审阅:在接受 AI 修改前逐个查看 diff,是最重要的安全习惯。
和 CodeRabbit 相关的补充
- 在线服务:CodeRabbit 的产品形态,决定了安装、权限和数据存放方式。
- 同类产品:Qodo、Greptile、Copilot Review。
- 所属方向:编程与开发。
把概念用起来
代码审查
适用情况:手头有一个 Pull Request 的改动时。
审查这个改动,按「必须修改 / 建议修改 / 可以忽略」三级列出问题,每条附上文件和行号,重点关注安全、并发和错误处理。
验收标准:问题定位到行。
延伸练习
读懂陌生代码库
输入:一个刚接手的项目仓库。
先不要改任何代码。请阅读这个仓库,输出:1)目录结构说明;2)主要模块之间的调用关系;3)本地运行步骤;4)你认为最脆弱的 3 个地方。
检查点:运行步骤能实际跑通。
写技术文档
适用情况:手头有一个模块的源码时。
根据源码为这个模块写 README:用途、安装、最小示例、配置项表格和常见问题。示例代码必须能直接运行。
检查点:示例代码可运行。
修复报错
输入:一段报错堆栈和相关代码。
这是报错信息和相关代码。请先解释报错原因,给出最小修改方案,并说明为什么这个修改不会影响其他调用方。
检查点:修改范围足够小。
常见问题:泄露密钥的风险
把密钥放在环境变量,规则文件中禁止读取 .env 等敏感文件。
常见问题:AI 改动范围过大
要求先给计划和文件清单,限定只改指定文件。
常见问题:测试全绿但功能不对
人工补充关键用例,检查测试是否真正断言了结果。
概念补充:上下文索引
把代码库建立索引,让 AI 回答时能引用相关文件。
概念补充:MCP
让编程工具连接外部数据和工具的协议。
适合人群:咨询顾问
咨询顾问可以用 CodeRabbit 处理行业研究、访谈整理等工作。需要注意:客户机密遵守保密协议,研究结论注明来源。
适合人群:研究生
研究生可以用 CodeRabbit 处理文献阅读、开题与论文写作等工作。需要注意:遵守学校学术诚信规定,AI 只用于辅助理解和润色。
适合人群:小店老板
小店老板可以用 CodeRabbit 处理门店宣传物料、顾客评价回复等工作。需要注意:价格和活动信息以实际为准,顾客电话等信息不要随意上传。
使用提醒
所有示例输出均为示意,不代表真实统计或效果承诺;请以自己的测试结果为准。
涉及个人信息、商业机密或受监管数据时,先确认 CodeRabbit 的数据处理条款,再决定能否使用。