Claude Code 模块设计:缩小公共接口,隐藏实现细节
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/codebase-design/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/codebase-design/`,把核对后的文件保存为 `.claude/skills/codebase-design/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/codebase-design`。
中文摘要
先说明模块负责什么,再定义调用方所需的少量公共方法,用行为测试验证边界。
SKILL.md 中文导读
可复现示例
给定 {module: 'ReadingQueue', actions: 'append next', internal: 'priority buckets'},调用方只需加入书目和获取下一本。工作步骤
- 用一句话确定职责,并列出调用方必须执行的操作。
- 隐藏存储方案,用公共方法设计可观察的测试。
验收方法
设计描述 {module: 'ReadingQueue', public: 'append next', exposeBuckets: false}。测试通过 next 核对返回书目。
GitHub 原文 · 更新日期
适用环境
在 Claude Code 打开现有代码或设计草案。样例在方案阶段检查接口,不加载 LiCode 服务。
常见问题
何时需要增加公共方法?
只有调用方确实有独立需求且现有方法无法表达时,再增加接口。维护内部顺序和数据结构留给模块。