用途:这是一套整洁代码(Clean Code)编码规范,用于在编写新代码或修改既有代码时统一命名、函数划分与文件结构,并在改动前做依赖与测试的影响评估。
主要能力:给出核心原则(SRP、DRY、KISS、YAGNI、童子军规则)及其实践检验方式;命名规则(变量揭示意图、函数为动词加名词、布尔用疑问式、常量用 SCREAMING_SNAKE、类用单数名词、枚举用 PascalCase)与命名反模式(隐晦缩写、泛化名、误导名、匈牙利命名);函数规则(不超过约20行、只做一件事、单一抽象层级、参数不超过3个、避免副作用);结构模式(卫语句、扁平优于嵌套、组合优于上帝函数、提取函数、就近放置);以及反模式清单(逐行注释、单行助手、过度工厂、杂物文件 utils.ts、深层嵌套、魔法数字、上帝函数、注释掉的代码、TODO 泛滥、过早抽象、复制粘贴、异常控制流、字符串类型化、回调地狱)。
使用方式:作为技能安装,命令为:npx clawhub@latest install clean-code(适用于 OpenClaw / Moltbot / Clawbot)。文档给出卫语句、参数对象、判别联合返回类型等前后对比示例,供改写时参照。修改文件前需回答:谁导入了此文件、此文件导入了什么、哪些测试覆盖它、是否为共享组件;并要求在同一任务中同步更新依赖文件。完成前自检目标、改动文件、编译运行、lint 与类型检查、遗漏项。
适用场景:日常编码、代码评审、重构,以及多人协作中涉及跨文件改动时。
限制:本技能为编码规范与检查清单,不包含自动化 lint 配置、具体语言版本要求、性能或收费信息;参考文档涵盖反模式、代码坏味道与重构目录,具体条目在资料中未逐条列出。