Skip to content

BATCH_REVIEW_GUIDE.md

Latest commit

 

History

History
204 lines (155 loc) · 4.29 KB

BATCH_REVIEW_GUIDE.md

File metadata and controls

204 lines (155 loc) · 4.29 KB

批量代码审查功能使用指南

功能概述

批量代码审查功能允许您对指定日期范围内的所有SVN提交进行AI代码审查，并生成详细的HTML报告。该功能不会发送钉钉通知，专门用于批量分析和报告生成。

功能特点

  • ✅ 支持指定日期范围的批量审查
  • ✅ 自动获取SVN提交记录和代码差异
  • ✅ AI智能代码分析和建议
  • ✅ 生成美观的HTML报告
  • ✅ 自动在浏览器中打开报告
  • ✅ 不发送钉钉通知（静默模式）

使用方法

方法一：使用批处理脚本（推荐）

  1. 双击运行 batch_review.bat
  2. 输入要审查的天数（默认7天）
  3. 等待审查完成并查看报告

方法二：直接使用Python脚本

# 审查最近7天的提交
python simple_batch_review.py

# 审查最近30天的提交
python simple_batch_review.py 30

配置说明

在 config.example.yaml 中的批量审查配置

batch_review:
  # 报告输出目录
  reports_dir: "reports"
  
  # 报告格式 (html/markdown/json)
  report_format: "html"
  
  # 默认监控路径（如果未指定）
  default_paths:
    - "/trunk/src"
    - "/branches/dev"
  
  # AI设置
  ai_settings:
    # 批次大小（每批处理的提交数）
    batch_size: 5
    # 批次间延迟（秒）
    delay_between_batches: 2
  
  # 是否在报告中包含代码差异
  include_code_diff: true

报告内容

生成的HTML报告包含以下内容：

1. 审查统计

  • 总提交数
  • 成功审查数
  • 审查失败数
  • 参与开发者数量

2. 详细审查结果

每个提交包含：

  • 📋 基本信息（版本号、作者、时间、提交消息）
  • 🤖 AI审查结果（总结、问题、建议）
  • 📝 代码变更差异（可选）

3. 审查总结

  • 主要发现
  • 常见问题类型
  • 改进建议

文件结构

报告目录 (reports/)
├── batch_review_20241201-20241208_143022.html    # HTML报告
├── batch_review_20241201-20241208_143022.json    # JSON数据（如果启用）
└── ...

使用场景

1. 周期性代码质量检查

# 每周审查
python simple_batch_review.py 7

# 每月审查
python simple_batch_review.py 30

2. 发布前代码审查

# 审查最近的变更
python simple_batch_review.py 3

3. 团队代码质量分析

批量审查可以帮助：

  • 发现代码质量趋势
  • 识别常见问题
  • 制定编码规范
  • 评估开发者代码质量

注意事项

1. 性能考虑

  • 大量提交的审查可能需要较长时间
  • AI API调用有频率限制，建议设置适当的批次延迟
  • 网络连接需要稳定

2. 资源使用

  • 确保有足够的磁盘空间存储报告
  • AI API调用会产生费用
  • SVN服务器连接需要稳定

3. 配置检查

运行前请确保：

  • ✅ SVN配置正确
  • ✅ AI API配置有效
  • ✅ 用户权限足够
  • ✅ 网络连接正常

错误处理

常见问题及解决方案

  1. SVN连接失败

    • 检查SVN服务器地址和凭据
    • 确认网络连接
    • 验证用户权限

  2. AI审查失败

    • 检查AI API配置
    • 验证API密钥有效性
    • 确认API额度充足

  3. 报告生成失败

    • 检查reports目录权限
    • 确认磁盘空间充足
    • 验证文件写入权限

示例输出

=== SVN批量代码审查工具 ===
审查最近 7 天的提交
时间范围: 2024-12-01 至 2024-12-08
获取 2024-12-01 到 2024-12-08 的提交记录...
找到 15 个唯一提交

找到 15 个提交，是否继续审查？(y/N): y
开始审查 15 个提交...
[1/15] 审查版本 12345
  ✓ 审查成功
[2/15] 审查版本 12346
  ✓ 审查成功
...

=== 完成 ===
总计: 15
成功: 14
失败: 1
报告: reports\batch_review_20241201-20241208_143022.html
已在浏览器中打开报告

扩展功能

未来可能的增强

  1. 高级过滤

    • 按作者过滤
    • 按文件类型过滤
    • 按提交消息关键词过滤

  2. 报告模板

    • 自定义报告模板
    • 多种输出格式
    • 报告对比功能

  3. 集成功能

    • 与CI/CD集成
    • 自动化定期审查
    • 邮件报告发送

技术支持

如遇到问题，请：

  1. 查看logs目录下的日志文件
  2. 运行diagnose.py进行系统诊断
  3. 检查配置文件格式和内容
  4. 验证网络和权限设置