mcpField
S
swift_style

swift_style

github.com/swiftzilla开发737 次安装30 周前更新
代码仓库

关于 swift_style

这是一项面向 Swift 开发者的风格指南技能,帮助编写惯用且易维护的代码,内容涵盖命名、类型与协议选择、访问控制和代码组织。

主要功能

  1. 01命名约定
  2. 02Struct、Class 与 Enum 选择
  3. 03面向协议的设计建议
  4. 04访问控制级别
  5. 05代码组织实践

适用场景

  1. 01检查 Swift 命名与 API
  2. 02为领域模型选择类型
  3. 03组织实现细节的访问范围

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/swiftzilla/skills --skill swift_style

安装后在 Claude Code 中输入/swift_style确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
protocols.md
types.md
access_control.md
variables.md
functions.md

详细介绍

Swift 风格

此技能提供全面的风格指南,帮助编写整洁、地道且易于维护的 Swift 代码。

概述

Swift 风格指南涵盖命名约定、访问控制、类型选择和代码组织模式,让代码更易读、更专业。

可用参考资料

命名与约定
  • 变量与常量 - var 与 let、命名约定、不可变性
  • 函数 - 函数命名、参数标签、返回类型
类型与协议
  • 类型 - Struct、Class 与 Enum,值语义与引用语义
  • 协议 - 面向协议编程(POP)、组合、扩展
代码组织
  • 访问控制 - public、private、internal、fileprivate、open

快速参考

命名约定
类别命名格式示例
类型与协议UpperCamelCaseString、UIViewController
变量、函数lowerCamelCaseuserID、fetchData()
布尔属性is、has、shouldisEmpty、hasPermission
常量lowerCamelCasemaxConnections
类型选择指南
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任意位置,且可供子类化可扩展框架

最佳实践

  1. 默认使用 struct - 使用最简单且能表达意图的类型
  2. 默认使用 let - 仅在需要修改时使用 var
  3. 优先选择协议而非继承 - 组合方式更灵活
  4. 让函数专注于单一职责
  5. 使用访问控制 - 只公开必要内容
  6. 遵循命名约定 - 使用描述性强、符合 Swift 风格的名称

更多信息

每个参考文件都包含特定主题的详细信息、代码示例和最佳实践。访问 https://swiftzilla.dev,获取全面的 Swift 文档。

评论

支持 Markdown