Code Review 代码审查
Code Review 提交前想先自查一遍时,AI 能按团队规范与评审流程逐条检查命名、格式与 lint,重点找逻辑错误、边界与异常、性能与安全问题并按严重度排序。它只给建议、不改代码,哪些属本次改动仍要你人工区分。
你需要准备
- 语言与框架版本,以及团队代码规范(命名 / 格式 / lint 规则)
- 代码托管平台与评审流程(GitHub PR / GitLab MR / 内部仓库)
- 优先提供本次 PR / MR 的 diff(含这次变更的目的 / 关联 issue);若只能贴整个文件,请说明会混入历史遗留问题、需人工区分是否属本次改动(缺的先标【待补】)
- 相关上下文:接口约定、边界规则、调用方
- (可选)已有的 lint / 静态检查结果(如 ESLint、SonarQube),用于避免重复已报问题
怎么做
- 先声明语言与框架版本、团队规范与评审流程
- 若代码含密钥、token,先脱敏再粘贴
- 优先发本次 diff + 变更目的(贴整文件时说明会混入历史问题),让 AI 按规范逐条检查(提示词可直接复制)
- 按严重程度处理问题,核对【待补】与【需确认】项后再改
下面是我写的【功能】的代码,语言与框架版本、团队代码规范(命名 / 格式 / lint 规则)、评审流程(GitHub PR / GitLab MR / 内部仓库)和本次变更目的我都先声明;我优先提供本次 PR / MR 的 diff,若只贴整个文件,请说明会混入历史遗留问题、哪些属本次改动需我人工区分,本次 diff 没贴全的部分请标【待补】。帮我做一次 code review:先按我声明的规范逐条检查命名、格式与 lint,再重点找逻辑错误、边界条件、空值和异常处理、性能问题、安全隐患,并结合改动目的判断逻辑是否符合意图,问题按严重程度排序,每条说明位置、为什么是问题、建议怎么改;若我提供了静态检查结果请结合处理、避免重复报告;只给建议、不要直接大改我的代码;把握不准的地方标【需确认】,不要编造。
它会交付什么
- 按严重程度排序的问题清单(位置、为什么是问题、建议怎么改)——属 AI 判断,需人工判断
- 逻辑错误、边界条件、空值与异常处理相关的问题
- 不符合团队规范(命名 / 格式 / lint)的项,以及性能与安全隐患(如未校验入参、SQL 拼接),不确定处标【需确认】;若按整文件审查,须人工区分哪些属本次改动
效果示例
输入一个约两百行的 TypeScript 订单模块 + ESLint 结果 → 输出按严重程度排序的问题清单;接口约定未给处标【需确认】。(示例为示意;判断仅供参考,需人工判断)
常见问题
PR 里的代码怎么审?AI 能按团队规范逐条挑出问题吗?
能按你声明的命名 / 格式 / lint 规范逐条查,再叠加逻辑、边界、性能与安全项,不会编;问题属 AI 判断,需人工判断。
只有整个文件、没有 diff,能审吗?
可以但不建议:整文件会把历史遗留问题一起报,噪声大;请说明哪些属本次改动,或尽量补上 diff 与变更目的。
审代码先看逻辑还是先看规范?
建议先按规范跑机械项(命名 / 格式 / lint),再看逻辑与边界、性能与安全;本次优先给 diff + 变更目的,判断才贴合意图。
会直接改我的代码吗?
不会。默认只给建议,改动由你决定。
一次能审多少行代码?
建议一个 PR 或一个模块为一批(约两三百行),整库建议分批;粘贴前把密钥、token 先脱敏。