代码 Review 助手。分析 Git diff 或代码片段,输出结构化中文 Review 报告,覆盖 Bug、安全漏洞、性能问题、可读性、最佳实践、类型安全、错误处理、测试覆盖。支持严格程度配置(信息/优化/标准/严重)和多种主流语言(Python/JS/TS/Java/Go/Rust)。支持 GitHub/G...
代码 Review 助手
功能概述
代码 Review 助手是一项面向实际任务的技能,主要用于第一步:获取代码;按优先级尝试以下方式:;
核心要点
- PR diff (最高优先级):运行 scripts/get_pr_diff.py ,支持 GitHub/GitLab;
- Git diff :运行 scripts/get_diff.py 获取本地变更;
- 用户粘贴 :直接分析用户提供的代码片段或 diff 文本;
使用与执行
指定文件 :读取用户指定的文件内容;第二步:确认严格程度。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
结果检查与注意事项
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。
代码 Review 助手
工作流程
第一步:获取代码
按优先级尝试以下方式:
- PR diff(最高优先级):运行
scripts/get_pr_diff.py,支持 GitHub/GitLab - Git diff:运行
scripts/get_diff.py获取本地变更 - 用户粘贴:直接分析用户提供的代码片段或 diff 文本
- 指定文件:读取用户指定的文件内容
第二步:确认严格程度
若用户未指定,默认使用标准模式。
| 模式 | 触发词 | 检查范围 |
|---|---|---|
| 🔵 信息 | 快速 review、简单看看 | 命名规范、注释完整性 |
| 🟢 优化 | -(默认最低) | 可读性问题、最佳实践 |
| 🟡 建议 | 标准 review | + 性能问题、明显 Bug |
| 🔴 严重 | 严格模式、PR review | + 安全漏洞、严重 Bug |
详见 references/severity-guide.md。
第三步:执行分析
按以下维度检查,详细规则见 references/review-dimensions.md:
- 🐛 潜在 Bug — 空指针、越界、异常处理、类型错误
- 🔒 安全问题 — SQL 注入、XSS、硬编码密钥、权限校验
- ⚡ 性能问题 — N+1 查询、不必要循环、低效数据结构
- 📖 可读性 — 过长函数、魔法数字、晦涩命名
- ✅ 最佳实践 — DRY 原则、错误处理一致性
- 🧪 类型安全 — 类型注解、隐式转换
- 🛡️ 错误处理 — 异常捕获、返回值校验
- 🧪 测试覆盖 — 关键逻辑缺少测试提示
第四步:语言特定规则
根据代码语言加载对应规则:references/languages/ 目录下包含:
python.md— Python 特定检查javascript.md— JavaScript/TypeScript 检查go.md— Go 语言检查java.md— Java 检查rust.md— Rust 检查
第五步:输出报告
支持三种格式,默认 Markdown:
- Markdown(默认):适合直接阅读和分享
- JSON:适合 CI 集成和二次处理,使用
--format json - HTML:适合生成可分享的报告,使用
--format html
输出模板见 references/report-template.md。
快速参考
| 用户说 | 对应操作 |
|---|---|
| "review 最近的提交" | get_diff.py --commits HEAD~1 |
| "review 和 main 的差异" | get_diff.py --branch main |
| "review GitHub PR #123" | get_pr_diff.py --provider github --pr 123 |
| "严格模式 review" | 启用 🔴 严重模式 |
| "快速看看" | 启用 🔵 信息模式 |
| "输出 JSON" | 使用 JSON 模板 |
| "生成 HTML 报告" | 使用 HTML 模板 |
注意事项
- 优先给出可操作的改进建议,不只是指出问题
- 每条意见附带具体行号(如能定位)
- 中文输出,技术术语保留英文原词
- 若 diff 超过 500 行,按文件分批处理,每批处理完询问是否继续
- 使用语言特定规则时,先识别代码语言再加载对应检查项
热门AI工具
相关专题
Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。
0
2026.10.28
Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。
0
2026.10.28
Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。
0
2026.10.28
本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。
0
2026.10.22
本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。
0
2026.10.22
本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。
0
2026.10.22
本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。
0
2026.10.22
本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。
0
2026.10.22
本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。
0
2026.10.22
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.6万人学习
共6课时 | 54.7万人学习
最新文章