关于 swift_style
这是一项面向 Swift 开发者的风格指南技能,帮助编写惯用且易维护的代码,内容涵盖命名、类型与协议选择、访问控制和代码组织。
主要功能
- 01命名约定
- 02Struct、Class 与 Enum 选择
- 03面向协议的设计建议
- 04访问控制级别
- 05代码组织实践
适用场景
- 01检查 Swift 命名与 API
- 02为领域模型选择类型
- 03组织实现细节的访问范围
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ swiftzilla/ skills --skill swift_style安装后在 Claude Code 中输入/swift_style确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/protocols.mdtypes.mdaccess_control.mdvariables.mdfunctions.md详细介绍
Swift 风格
此技能提供全面的风格指南,帮助编写整洁、地道且易于维护的 Swift 代码。
概述
Swift 风格指南涵盖命名约定、访问控制、类型选择和代码组织模式,让代码更易读、更专业。
可用参考资料
命名与约定
类型与协议
代码组织
- 访问控制 -
public、private、internal、fileprivate、open
快速参考
命名约定
| 类别 | 命名格式 | 示例 |
|---|---|---|
| 类型与协议 | UpperCamelCase | String、UIViewController |
| 变量、函数 | lowerCamelCase | userID、fetchData() |
| 布尔属性 | is、has、should | isEmpty、hasPermission |
| 常量 | lowerCamelCase | maxConnections |
类型选择指南
Need identity or reference semantics?
├── YES → Use Class
└── NO → Need inheritance?
├── YES → Use Class
└── NO → Modeling finite states?
├── YES → Use Enum
└── NO → Use Struct (default)
访问级别
| 修饰符 | 可见范围 | 使用场景 |
|---|---|---|
private | 封闭声明内部 | 严格封装 |
fileprivate | 同一文件 | 文件级辅助项 |
internal(默认) | 同一模块 | 实现细节 |
public | 任意位置 | 公共 API |
open | 任意位置,且可供子类化 | 可扩展框架 |
最佳实践
- 默认使用 struct - 使用最简单且能表达意图的类型
- 默认使用
let- 仅在需要修改时使用var - 优先选择协议而非继承 - 组合方式更灵活
- 让函数专注于单一职责
- 使用访问控制 - 只公开必要内容
- 遵循命名约定 - 使用描述性强、符合 Swift 风格的名称
更多信息
每个参考文件都包含特定主题的详细信息、代码示例和最佳实践。访问 https://swiftzilla.dev,获取全面的 Swift 文档。
评论
支持 Markdown