SuperAPI AI 工具集

review-clean-code

测试与质量

查看项目

更新于 10-15 22:13

技能介绍

用途:依据 Clean Code 原则对代码库做质量审查,聚焦 7 个高影响维度,只针对实现方式提建议,不改变代码功能、输出或行为。

主要能力:1) 命名问题,如 data1、temp 等无意义命名及同一概念命名不一致;2) 函数问题,如超过 100 行、参数多于 3 个、一函数多职责;3) 重复问题(DRY),如相似 if-else、重复的数据转换或错误处理;4) 过度设计(YAGNI),如永不成立的分支、仅一个实现的接口、无用 try-catch;5) 魔法数字,如裸数字与硬编码字符串;6) 结构清晰度,如嵌套三元、过度紧凑单行、条件嵌套超过 3 层;7) 项目约定,如导入顺序、函数声明风格、命名风格不一致,约定可参考 CLAUDE.md、AGENTS.md 或项目自定义规范。

使用方式:按工作流先扫描代码库确定待审文件,再逐维度检查,为每个问题评定 High/Medium/Low 严重级别,最后按严重程度排序生成报告。输出格式为问题类型、原则、位置 file:line、严重级别、问题描述与修复方向。流水线模式可输出 clean-code-review.md 人类可读报告与 clean-code-review.json 结构化问题列表,便于聚合、去重和统计。支持多智能体并行,可按检查维度(共 7 个)、模块/目录、语言(TypeScript、Python、Go)或文件类型拆分,例如 /review-clean-code --scope=components 或 --dimension=naming;聚合时需去重并统一严重级别。

适用场景:代码评审、重构前评估、团队规范落地。限制:资料未提供安装方式、收费、价格与平台支持信息;详细示例见 detailed-examples.md,语言模式见 language-patterns.md。