用途:在编写、评审或重构代码时使用,目标是让代码像通顺的文章一样易读:命名体现意图,函数只做一件事,类职责单一。核心原则是“童子军规则”——每次提交都让代码比接手时更干净。
主要能力:提供各主题快速参考,并附章节文件:names.md(有意义的命名)、functions.md(函数短小、参数少)、comments.md(注释取舍)、objects-and-data.md(对象与数据结构、迪米特法则、DTO)、error-handling.md(异常、空值处理、特例模式)、tests.md(TDD、F.I.R.S.T.)、classes.md(SRP、内聚、OCP、DIP),以及 smells-and-heuristics.md(66 种代码坏味道)。
要点示例:命名要有意图且可搜索,类名用名词、方法名用动词;函数理想 4–10 行,参数 0 个最好、3 个以上应封装为对象,布尔标志参数应拆分;命令查询分离,避免副作用。注释只用于法律声明、意图说明、后果警告、TODO、解释外部库行为,删除冗余、日志式、被注释掉的代码。错误处理优先异常而非返回码,包装第三方 API,不返回也不传递 null,可用空集合或特例模式替代。TDD 三定律与 F.I.R.S.T.(快速、独立、可重复、自验证、及时)。类遵循单一职责、内聚、开闭、依赖倒置,依赖注入以便测试。最关键的坏味道包括重复代码、函数做多件事、命名不描述、参数过多、标志参数、死代码、不一致、被注释代码。
使用方式:作为编码、评审、重构时的检查清单,按主题查阅对应章节文件。
限制:资料未提供安装命令、具体运行环境、收费或价格信息,也未说明与特定编辑器或工具的集成方式。