SuperAPI AI 工具集

code-reviewer

编程与开发

查看项目

更新于 10-15 14:28

技能介绍

用途

Code Reviewer 是一个代码审查技能,用于对代码进行全面的质量、安全与可维护性审查。根据其描述,它适用于审查代码变更、检查 PR、分析代码质量等场景。

主要能力

该技能围绕以下五个维度的审查清单展开:

代码质量:检查代码是否简单可读、函数与变量命名是否恰当、是否存在重复代码(DRY 原则)、复杂逻辑是否有适当注释、代码风格是否一致。

安全性:检查是否暴露密钥或 API key、是否实现输入验证、是否防止 SQL 注入、Web 代码是否防止 XSS、是否有正确的认证/授权检查。

错误处理:检查错误是否被适当捕获和处理、错误信息是否有意义、是否存在静默失败、是否有便于调试的日志记录。

性能:检查是否存在明显的性能瓶颈、算法与数据结构是否高效、是否在需要处使用缓存、数据库查询是否优化。

测试:检查测试覆盖是否充分、是否测试边界情况、测试是否可读可维护。

使用方式

根据资料,该技能的执行流程为:

  1. 使用 Read 工具读取目标文件;
  2. 使用 Grep 搜索模式和相关代码;
  3. 使用 Glob 查找相关文件;
  4. 对照审查清单分析代码;
  5. 提供带严重程度分级的结构化反馈。

输出格式

反馈按严重程度组织:

  • Critical(必须修复):可能导致安全漏洞、数据丢失或崩溃的问题。
  • Warning(应当修复):可能导致 bug、性能不佳或维护问题的问题。
  • Suggestion(建议考虑):针对可读性、一致性或最佳实践的改进建议。

资料中给出的示例反馈包括:在 user_service.py:45 发现 SQL 注入漏洞(用户输入未经净化直接传入查询,修复方式为使用参数化查询);在 api_client.py:23 缺少错误处理(网络错误会导致应用崩溃,修复方式为添加 try/catch 并返回适当错误响应);建议将 validators.py:78-95 中的验证逻辑提取为独立函数以提高复用性。

适用场景

适用于审查代码改动、检查 PR、分析代码质量,以及执行代码审查相关任务。

限制

资料未提供关于该技能的安装方式、收费模式、支持平台、具体实现细节或性能效果的信息,这些内容暂未提供。