关于 solid-principles
solid-principles 是一项编码技能,指导在代码组织中运用五项 SOLID 原则和信息隐藏。它还提倡保持模块专注,并将文件少于 200 行作为目标而非硬性规则。
主要功能
- 01运用五项 SOLID 原则
- 02改善信息隐藏
- 03将逻辑组织为专注的模块
- 04将 200 行作为文件长度目标
适用场景
- 01检查类的职责与依赖关系
- 02将大量逻辑拆分到多个文件
- 03评估接口与模块边界
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ gkwa/ volcanicviper --skill solid-principles安装后在 Claude Code 中输入/solid-principles确认已加载。
附带文件tile.json
详细介绍
遵循 SOLID 设计原则,并保持良好的信息隐藏:
- 单一职责原则(SRP):一个类应该只有一个修改理由。
- 开闭原则(OCP):对扩展开放,对修改关闭。
- 里氏替换原则(LSP):子类对象应该能够替换父类对象。
- 接口隔离原则(ISP):多个面向客户端的专用接口优于一个通用接口。
- 依赖倒置原则(DIP):高层模块不应依赖低层模块,两者都应依赖抽象。
单个代码文件应尽量控制在 200 行以内。这是一个目标,而非硬性限制;有充分理由的例外也可以接受。
将复杂逻辑拆分到多个独立文件中,而不是不断向单个文件中添加代码行。这样有助于信息隐藏,并使模块保持专注且易于理解。
编写代码时,请考虑:
- 是否遵循 SOLID 原则?如果没有,违反了哪些原则?
- 代码是否被组织成小型、专注的单元?
- 是否有可以改进信息隐藏的地方?
评论
支持 Markdown