SuperAPI AI 工具集

clean-code

通用与其它

查看项目

更新于 10-16 07:26

技能介绍

用途:该技能体现 Robert C. Martin(Uncle Bob)《Clean Code》的原则,用于把“能运行的代码”转化为“整洁的代码”,适合编写新代码、评审 Pull Request、重构遗留代码以及对齐团队规范。核心观点认为,代码若能由原作者之外的开发者阅读并增强,才算整洁。

主要能力:一是命名,要求意图明确(如 elapsedTimeInDays 而非 d)、避免误导、避免无意义区分、使用可发音可搜索的名字,类名用名词、方法名用动词。二是函数,要求短小、只做一件事、保持单一抽象层级、名称具描述性,参数理想为 0 个,1—2 个可接受,3 个以上需强理由,且不应有隐藏副作用。三是注释,主张不要为坏代码写注释而应重写,能用代码表达就用代码表达;法律、说明意图、澄清外部库、TODO 等属好注释,喃喃自语、冗余、误导、噪音等属坏注释。四是格式,采用“报纸隐喻”,高层概念在前、细节在后,相关行靠近,变量在使用处附近声明。五是对象与数据结构,强调数据抽象、迪米特法则(避免 a.getB().getC().doSomething())以及 DTO。六是错误处理,用异常代替返回码、先写 try-catch-finally、不返回 null、不传 null。七是单元测试,给出 TDD 三定律和 F.I.R.S.T. 原则(快速、独立、可重复、自验证、及时)。八是类,要求小且单一职责(SRP),遵循逐步下降规则。九是坏味道与启发式,包括僵化、脆弱、不可移植、粘滞、不必要的复杂与重复。

使用方式:资料提供了一个实现检查清单,例如函数是否少于 20 行、是否只做一件事、命名是否可搜索且表意、是否通过让代码更清晰来避免注释、参数是否过多、本次改动是否有失败测试。

适用场景与限制:仅当任务明确符合上述范围时使用;输出不能替代针对具体环境的验证、测试或专家评审;若缺少必要输入、权限、安全边界或成功标准,应停止并请求澄清。