SuperAPI AI 工具集

code-review-checklist

编程与开发

查看项目

更新于 10-15 13:10

技能介绍

用途

Code Review Checklist 是一个系统化的代码审查清单技能,用于帮助审查者全面、一致地检查代码质量。它覆盖功能正确性、安全性、性能、可维护性、测试覆盖和文档等关键维度,目标是减少遗漏、发现缺陷并保持代码库的一致性。

主要能力

该技能提供分步骤的审查流程:

  1. 理解上下文:明确代码解决的问题、需求、变更文件及原因、关联工单和测试策略。
  2. 审查功能:检查是否解决既定问题、边界情况、错误处理、逻辑错误和需求匹配度。
  3. 审查代码质量:评估可读性、命名、结构、函数聚焦度和复杂度。
  4. 审查安全:检查输入校验、敏感数据保护、SQL 注入风险、认证授权和依赖安全。
  5. 审查性能:关注不必要的循环、数据库访问优化、内存泄漏、缓存使用和 N+1 查询问题。
  6. 审查测试:验证新代码测试、边界用例覆盖、测试有效性和通过情况。

同时提供完整审查清单,涵盖预审查、功能、安全、性能、代码质量、测试、文档和 Git 提交等方面,并给出常见问题示例与改进对照,例如缺少输入校验、SQL 注入、硬编码密钥、命名不清、函数职责过多等。

使用方式

该技能以清单和模板形式使用。审查时按步骤逐项核对,可勾选检查项。技能还提供审查评论模板,包括请求修改、提问和表扬优秀代码的格式。建议每次审查都使用清单模板以保证一致性,并根据团队需求定制。

适用场景

  • 审查 Pull Request
  • 进行代码审计
  • 为团队建立代码审查标准
  • 培训新开发者代码审查实践
  • 确保审查不遗漏关键点
  • 编写代码审查文档

限制

资料未提供该技能的安装命令、运行环境要求、支持的编程语言范围、是否收费或价格信息,也未说明其与具体工具或平台的集成方式。相关事实暂未提供。