SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 11-13 02:02

技能介绍

用途

code-review 是一个代码审查技能,用于对单个文件、拉取请求或整个模块执行较全面的代码审查,重点关注最佳实践、安全漏洞、性能优化和代码可维护性。

主要能力

审查按四个类别组织:

  • 安全审查:SQL/命令注入、跨站脚本(XSS)、认证与授权问题、敏感数据暴露、不安全依赖、输入校验缺口。
  • 性能审查:算法复杂度(Big O)、数据库查询优化、内存管理、缓存机会、异步/并发处理、资源清理。
  • 代码质量审查:命名规范、函数/方法长度、代码重复(DRY)、单一职责原则、错误处理模式、日志与调试。
  • 可维护性审查:代码可读性、文档质量、测试覆盖、依赖管理、配置处理、破坏性变更风险。

使用方式

当用户请求代码审查时,技能建议先理解上下文(识别语言、框架和代码用途),再依次检查安全问题、评估性能、审查代码质量、评估可维护性,最后提供带示例的具体可执行反馈。资料给出的示例提示包括:审查拉取请求中的安全问题、检查函数的性能问题、审计模块的最佳实践、审查实现并建议改进、查找潜在缺陷、检查代码是否遵循 SOLID 原则。

输出格式包含:总结(总体评估,严重级别为 critical/high/medium/low)、发现的问题(文件与行号、类别、严重级别、问题描述、带代码示例的修复建议)、正面方面(做得好的地方)、建议(按优先级排列的改进清单)。

另附审查检查清单,覆盖通用项(可编译运行、无明显逻辑错误、错误处理、日志、避免硬编码)、安全项(输入校验、无 SQL 注入、无 XSS、敏感数据处理、认证授权检查)、性能项(无不必要循环、高效数据结构、查询优化、无内存泄漏、资源清理)、质量项(命名一致、函数小而专注、无重复代码、注释解释“为什么”、包含单元测试)。

严重级别定义:Critical 为安全漏洞或数据丢失风险,合并前必须修复;High 为重大缺陷或显著性能问题,合并前应修复;Medium 为代码质量问题或轻微缺陷,可考虑修复;Low 为风格问题或小幅改进,可选。

适用场景

适合在评审拉取请求、审计模块、排查性能瓶颈、查找潜在缺陷、检查代码规范与 SOLID 原则遵循情况时使用。

限制与注意事项

资料要求始终考虑项目上下文与约束,在彻底性与实用性之间取得平衡,提供建设性且可执行的反馈,认可良好实践,并在建议修改时考虑向后兼容性。资料未提供具体支持的语言列表、平台限制或收费信息。