代码 Review 助手

工作流程

第一步：获取代码

按优先级尝试以下方式：

1. PR diff（最高优先级）：运行 scripts/get_pr_diff.py，支持 GitHub/GitLab
2. Git diff：运行 scripts/get_diff.py 获取本地变更
3. 用户粘贴：直接分析用户提供的代码片段或 diff 文本
4. 指定文件：读取用户指定的文件内容

第二步：确认严格程度

若用户未指定，默认使用标准模式。

详见 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。

快速参考

注意事项

• 优先给出可操作的改进建议，不只是指出问题
• 每条意见附带具体行号（如能定位）
• 中文输出，技术术语保留英文原词
• 若 diff 超过 500 行，按文件分批处理，每批处理完询问是否继续
• 使用语言特定规则时，先识别代码语言再加载对应检查项