SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-16 05:29

技能介绍

用途

该技能用于对给定代码执行一次全面的代码审查。它定义了一套结构化的审查流程和输出格式,帮助审查者(或 AI 助手)系统性地检查代码质量,而不是零散地提出意见。

主要能力

技能将审查范围划分为五个方面:

  • 正确性:代码是否实现了预期功能;是否处理了边界情况;错误条件是否得到妥善处理。
  • 安全性:是否存在注入漏洞;输入验证是否恰当;是否暴露敏感数据;认证与授权是否正确。
  • 性能:是否存在明显的低效;是否存在 N+1 查询;是否存在不必要的计算;是否有内存方面的顾虑。
  • 可维护性:代码是否可读;函数是否职责单一;命名是否具有描述性;复杂逻辑是否有文档说明。
  • 测试:是否有测试;是否覆盖边界情况;测试是否有意义。

使用方式

技能以提示词形式提供,要求对“提供的代码”进行审查。使用时需要将待审查的代码作为输入交给该技能,技能会按照其定义的审查领域逐项检查,并生成结构化反馈。

输出格式

反馈分为四类:

  1. 关键问题(必须修复):给出问题、位置和推荐的修复方式。
  2. 建议(应考虑):给出改进点及其理由。
  3. 细节(可选/次要):小的改进项。
  4. 值得肯定之处:指出代码中的积极方面。

技能要求反馈保持建设性,并对每条建议解释“为什么”。

适用场景

适用于需要对一段代码进行系统性质量检查的场合,例如提交代码前的自查、团队内部评审的辅助、学习代码审查方法时的参考框架。

限制

资料中未提供该技能的具体实现方式、是否依赖特定模型或工具、是否支持自动修复、是否可集成到 CI/CD 流程等信息。审查的深度和准确性取决于输入的代码内容以及运行该技能的模型能力。资料中未提及收费、价格或平台支持情况。