SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-15 09:51

技能介绍

用途

该技能用于执行深度、只读的代码审查。它适用于分析整个代码库,或用户明确提及的文件。当被要求审查代码中的逻辑错误、类型问题、安全漏洞、性能瓶颈、可靠性问题或回归风险时使用。

主要能力

  • 检查范围内所有文件,优先处理真实问题而非风格挑剔。
  • 生成结构化报告,包含清晰证据和影响说明。
  • 支持用户指定的额外关注点(如可访问性、API 一致性、架构),并将其作为一等审查维度。
  • 按严重程度(严重、高、中、低)对发现进行排序。
  • 每条发现包含:严重程度、文件与行号引用、问题描述、影响、最小推荐修复方向。
  • 报告还包含:范围摘要、未发现问题的区域、开放问题或假设、残余风险或测试缺口。

使用方式

该技能遵循明确的审查工作流:

  1. 定义范围:确定范围是整个代码库还是特定文件。必要时扩展范围到直接相关的文件以验证行为。在最终报告中记录范围边界。
  2. 构建文件清单:在分析前枚举范围内的文件,按区域分组(运行时代码、配置、基础设施、测试、模式、迁移、脚本)。当要求完整覆盖时,不进行抽样。
  3. 分析每个范围内文件:至少检查逻辑正确性与边界情况、类型安全与类型漂移风险、安全漏洞与不安全的信任边界、性能瓶颈与不必要的工作、可靠性问题(错误处理、重试、竞态条件、资源泄漏)、隐式假设或脆弱耦合带来的回归风险。
  4. 验证发现质量:仅报告有具体证据的问题。优先高信号发现而非推测性评论。如不确定,明确标记不确定性及确认方式。区分错误与改进。
  5. 生成最终报告:按严重程度排序,包含上述字段。

适用场景

  • 需要全面审查整个代码库或指定文件时。
  • 需要识别逻辑错误、类型问题、安全漏洞、性能问题、可靠性问题或回归风险时。
  • 需要结构化、可操作的审查报告时。
  • 用户有特定关注领域(如可访问性、API 一致性、架构)需要纳入审查时。

限制

  • 审查过程中绝不修改代码。
  • 绝不创建、删除或重写项目文件作为审查输出的一部分。
  • 用户关注领域被视为强制优先级。
  • 如果用户要求全代码库审查,检查仓库中所有可能影响行为的文件。
  • 如果用户指定特定文件,完整检查所有指定文件。
  • 除非文件实际被打开并分析,否则不声称已审查该文件。
  • 仅报告有具体证据的问题,避免无证据的通用建议。
  • 如未发现问题,明确说明并列出残余风险。

审查者心态

  • 对安全路径像攻击者一样思考。
  • 对性能路径像生产流量一样思考。
  • 对可靠性和清晰度像未来维护者一样思考。
  • 关注行为和风险,而非个人风格偏好。