SuperAPI AI 工具集

review-clean-code

编程与开发

查看项目

更新于 10-15 21:38

技能介绍

用途:基于《Clean Code》原则对代码进行质量审查,聚焦命名、函数、重复、过度设计、魔法数字、结构清晰度与项目约定七个高影响维度,只针对实现方式给出改进方向,不改变代码功能、输出或行为。

主要能力:1)命名问题,识别 data1、temp、result 等无意义命名及同概念命名不一致;2)函数问题,识别超 100 行函数、参数超过 3 个、一函数多职责;3)重复问题,识别相似 if-else、数据处理与错误处理逻辑及复制粘贴痕迹;4)过度设计(YAGNI),识别永不成立的条件分支、仅一个实现的接口、无用 try-catch;5)魔法数字,识别无说明的裸数字与硬编码字符串,建议改为具名常量;6)结构清晰度,识别嵌套三元、过度紧凑单行、超过 3 层条件嵌套;7)项目约定,识别导入顺序、函数声明风格、命名风格不一致。

使用方式:按工作流先扫描代码库确定待审文件,再逐维度检查、评级、生成按严重程度排序的报告。严重程度分为 High(影响可维护性/可读性,应立即修复)、Medium(有改进空间,建议修复)、Low(代码异味,可选优化)。输出格式为问题类型、原则、位置 file:line、严重程度、问题描述与修复方向。流水线模式可产出 clean-code-review.md 报告与 clean-code-review.json 结构化问题列表。支持多代理并行,可按维度(共 7 个)、模块/目录、语言或文件类型拆分,示例:/review-clean-code --scope=components 或 --dimension=naming,聚合时需去重并统一评级。

适用场景:需要对代码库做系统性整洁度审查并生成可排序、可聚合问题清单的团队或工程流程。

限制:项目约定的判定应参考 CLAUDE.md、AGENTS.md 或项目自定义编码规范;具体价格、支持平台、效果数据等事实暂未提供。