SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-16 04:46

技能介绍

代码 Review 是一个用于软件开发流程的技能,定位为每个模块开发完成后必须执行的检查环节。

用途 该技能用于在模块开发完成后对代码进行系统性审查,覆盖逻辑、规范、安全、文档、清洁度、重复度和可读性等方面,帮助团队在提交或合并前发现并修正问题。

依赖规范 执行前需引用以下规范文件:

  • ../rules/review-base.md
  • ../rules/coding-standards.md
  • ../rules/web-standards.md

主要能力与检查步骤 每个步骤先输出标题,再输出结果,具体包括:

  1. 逻辑正确:检查逻辑是否符合需求,边界条件是否已处理(空值、极值、异常输入)。
  2. 规范符合:按 coding-standards 逐项检查,输出每项检查结果;Web 项目同时检查 web-standards。
  3. 安全检查:检查是否有敏感信息硬编码,用户输入是否有校验。
  4. 文档同步:若修改了公共模块,检查使用文档和演示入口页面是否已同步更新。
  5. 代码清洁:检查是否有未使用的变量、函数、import 等死代码。
  6. 无重复:检查是否有重复逻辑和代码,可复用部分是否已提取。
  7. 可读性:检查命名是否清晰,函数和类是否有注释,复杂逻辑是否有过程说明。

使用方式 在模块开发完成后触发该技能,按上述步骤依次执行并输出结果。具体触发方式、命令或集成方式暂未提供。

适用场景 适用于软件开发过程中的代码审查环节,尤其适合需要统一规范、关注安全与文档同步的团队项目,以及包含 Web 前端的项目。

限制 该技能依赖 review-base、coding-standards、web-standards 三份规范文件,缺少这些文件时无法完整执行规范符合性检查。关于支持的平台、是否收费、价格、实际效果等信息暂未提供。