SuperAPI AI 工具集

code-review-checklist

编程与开发

查看项目

更新于 10-16 06:54

技能介绍

Code Review Checklist 是一份代码审查指南,用于在评审代码时逐项核对代码质量、安全性与最佳实践。资料以清单形式组织,主要分为快速审查清单、AI 与 LLM 审查模式、需要标记的反模式,以及审查评论指南四部分。

用途 该清单用于代码评审场景,帮助评审者系统性地检查提交的代码,避免遗漏关键问题。它既适用于人工评审,也针对 2025 年出现的 AI 生成代码与 LLM 集成代码补充了专门的审查要点。

主要能力(快速审查清单) 清单按以下维度列出检查项:

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

AI 与 LLM 审查模式(2025)

  • 逻辑与幻觉:思维链是否遵循可验证的路径;AI 是否考虑了空状态、超时与部分失败;代码对文件系统或网络是否做了安全的假设。
  • 提示词工程审查:资料给出对比示例,指出模糊提示词(如直接传入 userInput)与结构化安全提示词(包含 system 角色、对输入做 sanitize、指定 schema)之间的差异。

需要标记的反模式 资料列举了若干反模式及其改进写法:魔法数字应改为具名常量;深层嵌套应改为提前返回;过长函数(100 行以上)应拆分为小而专注的函数;any 类型应改为明确类型。

审查评论指南 资料建议用标记区分评论级别:🔴 表示阻塞性问题(如 SQL 注入漏洞),🟡 表示重要建议(如考虑使用 useMemo 提升性能),🟢 表示细枝末节(如不可变变量优先用 const 而非 let),❓ 表示提问(如用户为 null 时会发生什么)。

适用场景 适用于团队或个人在代码评审、Pull Request 审查、AI 生成代码的复核等场景中作为核对清单使用。

限制 资料未提供该清单的安装方式、运行环境、平台支持、收费模式或具体使用步骤,这些信息暂未提供。