SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 03:42

技能介绍

用途:在需要代码质量审查、重构指导、SOLID 原则应用或识别与修复代码坏味道时使用。技能基于 Robert C. Martin、Martin Fowler、Kent Beck 的相关工作,覆盖 SOLID、DRY、代码坏味道识别、重构模式、命名约定、错误处理与复杂度管理。

主要能力:分三阶段工作。阶段一在完整上下文中阅读代码,理解职责与目的,测量圈复杂度,梳理耦合与依赖,记录已有测试。阶段二用参考表归类坏味道,如过长方法(>30 行)、过大类(>300 行或 >5 项职责)、长参数列表(>3 个)、数据泥团、基本类型偏执、switch 语句、发散式变化、霰弹式修改、死代码、投机性泛化等,并为每个坏味道标注优先级与重构方式。阶段三一次只应用一个重构,每次改动后运行测试,失败立即回滚,直到高优先级坏味道解决且行为不变。

使用方式:开始时声明“I'm using the clean-code skill to improve code quality.”。按阶段推进,每阶段有明确的停止条件,未满足前不进入下一阶段。技能还给出 SOLID 各原则的坏味道与修复方向、命名约定(变量用名词、布尔用 is/has/can/should 前缀、常量用 UPPER_SNAKE_CASE、类用 PascalCase)、函数规模建议(理想 5-15 行,最多 30 行,参数最多 3 个)、卫语句、错误处理决策表与 Result 类型模式、复杂度风险分级(1-5 低、6-10 中、11-20 高、21+ 严重)、DRY 决策表、注释哲学与常见反模式。

适用场景:代码审查、重构、遗留代码清理、团队编码规范落地,以及与 code-review、test-driven-development、senior-frontend、senior-backend、performance-optimization、systematic-debugging 等技能配合。

限制:技能类型为 FLEXIBLE,需按上下文判断,并非每个函数都要 5 行,也不是每个模式都要 SOLID,应以团队可读性优先于理论纯粹性。资料未提供安装命令、收费、价格与平台信息。