SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 06:22

技能介绍

用途:在代码审查、重构改写或编写新代码时,按 Robert C. Martin《代码整洁之道》的规则体系做整洁化,并在命名、函数、注释等单点疑问上查规则。规则引用编号(如 C1/E2/F3/G5/N4/T7)对应原书第 17 章 66 条坏味道与启发式清单,章节号(如 ch3.6.5)对应原书章节。

主要能力:覆盖命名(名副其实、避免误导、可搜索、一概念一词等)、函数(短小、只做一件事、一层抽象、参数控制、禁 flag 参数、无副作用、命令查询分离、异常优于错误码、去重复)、注释(好注释与坏注释、过期注释、注释掉的代码)、格式、数据与对象、类与系统、错误处理与边界、测试(F.I.R.S.T 等)以及并发。

使用方式:先判模式。贴代码并问审查/重构时走审查模式,逐行按坏味道清单匹配违规、标编号、按严重度排序,并给出违规编号、问题定位与改写示例;描述需求或给草稿时走顾问模式,先写测试用例,再最简实现跑通,然后按命名→函数粒度→去重复→命令查询分离→去注释→格式的顺序重构,输出整洁代码与规则依据。改写会改变对外契约或波及超过三个调用点时,需先报改动清单待确认。

适用场景:面向对象语言的代码层整洁化与审查。

限制:原书以 Java 为例,函数式与系统语言部分规则需按语言机制翻译;原著 2008 年,未覆盖 Optional、记录类、不可变数据等当代特性;不替代架构选型与性能优化;66 条坏味道非穷尽清单;不揣测作者对当代新议题的立场。原型、一次性脚本与即将废弃代码不必强求整洁。