SuperAPI AI 工具集

code-review-checklist

编程与开发

查看项目

更新于 10-15 15:34

技能介绍

用途

这份技能是一份代码审查清单,用于在代码评审过程中系统性地检查代码质量、安全性和最佳实践。它把评审关注点组织成可逐项核对的条目,帮助审查者不遗漏关键问题。

主要能力

清单覆盖以下评审维度:

  • 正确性:代码是否实现了预期功能、边界情况是否处理、是否有错误处理、是否有明显 bug
  • 安全性:输入是否校验与净化、是否存在 SQL/NoSQL 注入漏洞、是否存在 XSS 或 CSRF 漏洞、是否有硬编码的密钥或敏感凭证。针对 AI 场景还列出:Prompt Injection 防护(如适用)、输出在用于关键位置前是否经过净化
  • 性能:是否存在 N+1 查询、是否有不必要的循环、缓存是否合理、是否考虑打包体积影响
  • 代码质量:命名是否清晰、是否 DRY(无重复代码)、是否遵循 SOLID 原则、抽象层次是否恰当
  • 测试:新代码是否有单元测试、边界情况是否测试、测试是否可读可维护
  • 文档:复杂逻辑是否有注释、公共 API 是否有文档、README 是否需要更新

此外还包含 AI 与 LLM 审查模式:

  • 逻辑与幻觉:思维链是否有可验证的路径、是否考虑了空状态、超时和部分失败、对文件系统或网络的假设是否安全
  • 提示工程审查:对比了含糊提示与结构化安全提示的写法,示例中展示 system、input: sanitize(userInput)、schema: ResponseSchema

清单也列出需要标记的反模式,并给出正反示例:魔术数字对比命名常量、深层嵌套对比提前返回、超长函数对比小而专注的函数、any 类型对比明确类型。

使用方式

清单提供 Review Comments Guide,用符号区分评论级别:

  • 🔴 阻塞性问题:如 🔴 BLOCKING: SQL injection vulnerability here
  • 🟡 重要建议:如考虑使用 useMemo 提升性能
  • 🟢 轻微问题(nit):如不可变变量优先用 const
  • ❓ 疑问:如用户为 null 时会发生什么

适用场景

适用于人工代码评审、Pull Request 审查,尤其适合涉及 AI/LLM 生成代码或 AI 集成代码的评审。

限制

资料未提供该清单的具体使用流程、安装命令、平台支持、收费方式或与具体工具的集成细节,这些信息暂未提供。