SuperAPI AI 工具集

uncle-bob-clean-code-best-practices

编程与开发

查看项目

更新于 10-16 03:46

技能介绍

用途:这是基于 Robert C. Martin(Uncle Bob)《Clean Code: A Handbook of Agile Software Craftsmanship》整理的软件工艺指南,包含 45 条规则、8 个类别,按影响程度排序,用于指导代码评审、重构决策和新代码开发。

适用时机:编写新函数、类或模块时;为变量、函数、类或文件命名时;评审代码可维护性问题时;重构已有代码以提升清晰度时;编写或改进单元测试时。

规则类别与优先级:1. 有意义命名(CRITICAL,前缀 name-);2. 函数(CRITICAL,前缀 func-);3. 注释(HIGH,前缀 cmt-);4. 格式(HIGH,前缀 fmt-);5. 对象与数据结构(MEDIUM-HIGH,前缀 obj-);6. 错误处理(MEDIUM-HIGH,前缀 err-);7. 单元测试(MEDIUM,前缀 test-);8. 类与系统(MEDIUM,前缀 class-)。

各类要点:命名要求揭示意图、避免误导与无意义区分、可发音、可搜索、避免编码前缀,类名用名词短语、方法名用动词短语。函数要求短小、只做一件事、保持同一抽象层级、减少参数、避免副作用、命令查询分离、优先异常而非错误码、避免重复。注释主张用代码表达意图、解释意图、避免冗余与注释掉的代码、用注释警示后果。格式涉及垂直排版、避免水平对齐、遵循团队规则与缩进。对象部分涉及数据抽象、数据/对象非对称、迪米特法则、避免混合结构、使用 DTO。错误处理要求使用异常而非返回码、先写 try-catch-finally、提供上下文、按调用者需求定义异常、避免返回或传入 null。单元测试要求遵循 TDD 三定律、保持测试整洁、每个测试一个断言、FIRST 原则、Build-Operate-Check 模式。类与系统要求类小、内聚、面向变更组织、隔离变更、构造与使用分离。

使用方式:按需阅读各个参考文件获取详细说明与代码示例;references/_sections.md 为类别定义与排序;assets/templates/_template.md 为新增规则模板;metadata.json 提供版本与参考信息。安装命令、具体调用方式及平台支持在现有资料中暂未提供。