用途:clean-code-principles 提供与编程语言无关的软件设计与代码质量准则,用于设计新功能或系统、审查代码架构、重构既有代码、讨论设计决策以及改进代码质量时作为参考。
主要能力:按优先级组织规则类别,包括 SOLID 原则(关键)、核心原则(关键)、设计模式(高)、代码组织(高)、命名与可读性(中)、函数与方法(中)、注释与文档(低)。SOLID 覆盖单一职责、开闭、里氏替换、接口隔离、依赖倒置;核心原则覆盖 DRY、KISS、YAGNI、关注点分离、组合优于继承、迪米特法则、快速失败、封装;设计模式覆盖工厂、策略、仓储、装饰器、观察者、适配器、门面、依赖注入;代码组织涉及按功能分目录、模块边界、分层架构、包内聚、避免循环依赖;命名强调意图明确、一致、可搜索、避免匈牙利命名、使用领域语言;函数强调短小、单一用途、少参数、少副作用、命令查询分离;注释强调自解释代码、解释为何而非是什么、避免冗余、记录公共 API。资料称共覆盖 3 大类别 23 条规则。
使用方式:阅读具体规则文件获取详细说明,如 rules/solid-srp-class.md、rules/core-dry.md、rules/pattern-repository.md。审查代码时可按“file:line - [principle] 问题描述”的格式输出发现,例如 src/services/UserService.ts:15 - [solid-srp] 类同时处理校验、持久化和通知。
限制:资料未提供安装命令、运行程序或自动化集成步骤;未说明适用平台、收费方式与量化效果。规则引用 Robert C. Martin、GoF、Martin Fowler 等著作与站点,具体条款以规则文件为准。版本 1.0.0,MIT 许可,标注最后更新时间 2026-01-17。