SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-15 21:42

技能介绍

用途:对指定源码按《Clean Code》标准做代码级整洁度分析并给出修改建议,不修改代码,只输出发现。

主要能力:覆盖九个维度——命名、函数、注释、格式、对象与数据结构、错误处理、边界、单元测试、并发,引用 references 下对应参考文件及 heuristics.md 中的 G/N/C/E/F/T 规则代码。不分析类职责、继承与接口设计、包与模块架构、系统级过度设计(对应原书第 10-12 章),发现此类问题仅在总结的 Out of scope 中一行点名。

使用方式:可用子命令 cleancode / cleancode all / cleancode check 检查全部九个维度,或 cleancode names、functions、comments、formatting、objects、errors、boundaries、tests、concurrency 等按维度过滤;未给子命令时默认全量。报告为结构化文本,每条发现含维度、严重性、位置、引用、问题与具体修法;末尾给出发现表、计数表、优先修前三项、总体评价与范围外事项。用户要求 fix it 时进入修复模式,仅按已报告发现改动代码。

适用场景与限制:适合日常代码审查、函数过长或命名不清等问题的检查,适用于 Python、Java、TypeScript、C#、Go、Rust、PHP、Kotlin、C++ 等语言,需按各语言习惯判断而非照搬书中 Java 示例。未指定目标时会询问扫描范围;大型目标按严重性排序并最多报告约 15 条。参考引用必须逐字来自规则注册表,不得编造代码;若目标代码整体整洁,可报告“No significant findings.”。需注意该技能本身不修改代码,且不涵盖类设计、架构与系统复杂度问题。