Swift Style

johnrogers/claude-swift-engineering/plugins/swift-engineering/skills/swift-style

作者 johnrogers1dc2cf4d020b无许可证231 个星标收录于 2026年10月9日更新于 2026年10月9日仓库8个月前更新

Swift code style conventions for clean, readable code. Use when writing Swift code to ensure consistent formatting, naming, organization, and idiomatic patterns.

AI 生成的概览

Swift 代码风格规范,用于编写整洁、可读的代码,涵盖命名、格式、组织与惯用模式。

功能
提供一份 Swift 风格指南,涵盖命名、黄金路径、代码组织、空格、self 用法、计算属性、闭包、类型推断、语法糖、访问控制、内存管理、注释和常量。它还列出常见错误,例如缩写、嵌套 guard、self 用法不一致、过于笼统的类型名以及隐式访问控制。它产出的是指导而非文件或代码。
适用场景
在编写或审查 Swift 代码并希望保持一致的格式、命名和惯用模式时使用。也适合在最终确定 Swift 代码前检查常见的风格错误。
运行要求
不需要任何工具、软件包、运行时、凭据或网络访问;它仅包含说明,不附带脚本。

Swift Style Guide

Code style conventions for clean, readable Swift code.

Core Principles

Clarity > Brevity > Consistency

Code should compile without warnings.

Naming

  • UpperCamelCase — Types, protocols
  • lowerCamelCase — Everything else
  • Clarity at call site
  • No abbreviations except universal (URL, ID)
swift
// Preferredlet maximumWidgetCount = 100func fetchUser(byID id: String) -> User

Golden Path

Left-hand margin is the happy path. Don't nest if statements.

swift
// Preferredfunc process(value: Int?) throws -> Result {    guard let value = value else {        throw ProcessError.nilValue    }    guard value > 0 else {        throw ProcessError.invalidValue    }    return compute(value)}

Code Organization

Use extensions and MARK comments:

swift
class MyViewController: UIViewController {    // Core implementation}
// MARK: - UITableViewDataSourceextension MyViewController: UITableViewDataSource { }

Spacing

  • Braces open on same line, close on new line
  • One blank line between methods
  • Colon: no space before, one space after

Self

Avoid self unless required by compiler.

swift
// Preferredfunc configure() {    backgroundColor = .systemBackground}

Computed Properties

Omit get for read-only:

swift
var diameter: Double {    radius * 2}

Closures

Trailing closure only for single closure parameter.

Type Inference

Let compiler infer when clear. For empty collections, use type annotation:

swift
var names: [String] = []

Syntactic Sugar

swift
// Preferredvar items: [String]var cache: [String: Int]var name: String?

Access Control

  • private over fileprivate
  • Don't add internal (it's the default)
  • Access control as leading specifier

Memory Management

swift
resource.request().onComplete { [weak self] response in    guard let self else { return }    self.updateModel(response)}

Comments

  • Explain why, not what
  • Use // or ///, avoid /* */
  • Keep up-to-date or delete

Constants

Use case-less enum for namespacing:

swift
enum Math {    static let pi = 3.14159}

Common Mistakes

  1. Abbreviations beyond URL, ID, UUID — Abbreviations like cfg, mgr, ctx, desc hurt readability. Spell them out: configuration, manager, context, description. The three exceptions are URL, ID, UUID.

  2. Nested guard/if statements — Deep nesting makes code hard to follow. Use early returns and guards to keep the happy path left-aligned.

  3. Inconsistent self usage — Either always omit self (preferred) or always use it. Mixing makes code scanning harder and confuses capture semantics.

  4. Overly generic type names — Manager, Handler, Helper, Coordinator are too vague. Names should explain responsibility: PaymentProcessor, EventDispatcher, ImageCache, NavigationCoordinator.

  5. Implied access control — Don't skip access control. Explicit private, public helps future maintainers understand module boundaries. internal is default, so omit it.

来源与署名

来源:johnrogers/claude-swift-engineering位于plugins/swift-engineering/skills/swift-style提交1dc2cf4

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架