SuperAPI AI 工具集

code-review-checklist

编程与开发

查看项目

更新于 10-16 06:15

技能介绍

用途:为代码审查提供结构化检查清单,帮助审查者系统排查问题并统一评论表达。

主要能力: 正确性:确认代码实现预期功能、处理边界情况与错误处理、无明显 bug。 安全:输入校验与清洗、防止 SQL/NoSQL 注入、XSS、CSRF,禁止硬编码密钥;涉及 AI 时检查 Prompt Injection 防护与输出在关键使用点前是否清洗。 性能:避免 N+1 查询、不必要循环,合理使用缓存,考虑打包体积影响。 代码质量:命名清晰、遵循 DRY 与 SOLID、抽象层级合适。 测试:新代码配套单元测试、覆盖边界情况、测试可读可维护。 文档:复杂逻辑有注释、公开 API 有文档、必要时更新 README。 AI & LLM 审查:检查逻辑是否可验证、是否考虑空状态/超时/部分失败、对文件系统或网络的外部假设是否安全;Prompt 应结构化并使用 schema 与输入清洗。 反模式识别:魔法数字应改为命名常量、深层嵌套改为提前返回、超长函数拆分为小函数、避免 any 类型而使用明确类型。

使用方式:以清单逐项审查,按评论规范标注:🔴 表示阻塞问题、🟡 表示重要建议、🟢 表示细节建议、❓ 表示提问。

适用场景:人工代码审查、Pull Request 评审,尤其是包含 AI/LLM 调用的代码。

限制:资料未提供安装命令、运行方式、平台支持、收费信息或与工具集成的具体步骤,暂未提供。