SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-15 08:09

技能介绍

用途

Code Review 是一个代码审查技能,用于在开发过程中系统性地检查代码质量。当用户要求“review this code”“check my code”或类似请求时,该技能会被触发,帮助发现代码中的缺陷、安全漏洞、性能问题以及不符合最佳实践的写法。

主要能力

该技能按照七个维度进行结构化审查:

  1. 理解上下文:先用 1-2 句话总结代码用途,明确哪些文件被修改以及原因;如果审查的是 diff,需要同时理解修改前后的情况。

  2. 正确性:检查是否存在逻辑错误;边界情况(null、空值、零、负数、边界值)是否处理;错误路径是否有恰当且有意义的错误信息;返回类型和值是否正确;异步操作是否处理得当(缺失 await、竞态条件)。

  3. 安全性:检查 SQL 或 NoSQL 注入风险;XSS 漏洞(未净化的用户输入被渲染到 HTML);硬编码的密钥、API key 或凭证;eval()、innerHTML 或动态代码执行的不安全使用;缺失的认证或授权检查;日志或错误信息中的敏感数据暴露。

  4. 性能:检查不必要的循环或 O(n²) 操作;频繁查询缺少数据库索引;N+1 查询问题;不必要地长期持有大对象;列表接口缺少分页;循环内可批处理的昂贵操作。

  5. 可读性与可维护性:变量和函数命名是否清晰描述性;函数是否小而专注(单一职责);是否存在应提取的重复代码;魔法数字或字符串是否替换为命名常量;复杂逻辑是否有注释或自解释。

  6. 测试:新增或修改的代码是否有测试;测试是否覆盖正常路径和错误情况;测试是否针对行为而非实现细节;mock 使用是否恰当(没有过度 mock)。

  7. 项目规范:代码是否遵循项目已有的模式和约定;import 组织是否一致;是否符合 lint 和格式化规则;类型是否正确定义(TypeScript 中无不必要的 any)。

使用方式

该技能以结构化流程执行审查,并采用统一的输出格式。每个发现的问题按以下格式报告:

[SEVERITY] Category — File:Line
Description of the issue.

Suggested fix:

// corrected code here

严重级别分为三档:

  • 🔴 CRITICAL — 缺陷、安全漏洞、数据丢失风险。必须修复。
  • 🟡 WARNING — 性能问题、缺失错误处理、潜在问题。应当修复。
  • 🟢 SUGGESTION — 可读性、风格、次要改进。可选优化。

每次审查结束时需要给出总结,包括:总体评估(是否可安全合并:Yes / Yes with changes / No)、关键问题数量(必须修复项的数量)、做得好的前三项(始终强调积极面)、最值得改进的前三项。

适用场景

适用于代码提交前的审查、Pull Request 评审、代码质量自查,以及需要从正确性、安全性、性能、可维护性、测试和项目规范等多角度系统检查代码的场合。

限制

该技能的具体安装方式、运行环境要求、支持的编程语言范围、是否收费及价格等信息暂未提供。