Swift スタイルガイド

クリーンで読みやすい Swift コードのためのコードスタイル規約です。

コアプリンシプル

明確さ > 簡潔さ > 一貫性

コードはWarningなしでコンパイルされるべきです。

ネーミング

• UpperCamelCase — Types、protocols
• lowerCamelCase — その他すべて
• 呼び出し地点での明確性
• 汎用的なもの(URL、ID)以外は略語なし

// Preferred
let maximumWidgetCount = 100
func fetchUser(byID id: String) -> User

ゴールデンパス

左マージンが成功時のパスです。if 文をネストしないでください。

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

コード構成

拡張機能とMARKコメントを使用してください:

class MyViewController: UIViewController {
    // Core implementation
}

// MARK: - UITableViewDataSource
extension MyViewController: UITableViewDataSource { }

スペーシング

• ブレースは同じ行で開き、新しい行で閉じる
• メソッド間は1行の空行
• コロン: 前に空白なし、後ろに1つの空白

Self

コンパイラが必須でない限り self を避けてください。

// Preferred
func configure() {
    backgroundColor = .systemBackground
}

計算型プロパティ

読み取り専用の場合は get を省略してください:

var diameter: Double {
    radius * 2
}

クロージャ

末尾のクロージャは単一クロージャパラメータのみ使用します。

型推論

明確な場合はコンパイラに推論させてください。空のコレクションの場合は型アノテーションを使用してください:

var names: [String] = []

シンタックスシュガー

// Preferred
var items: [String]
var cache: [String: Int]
var name: String?

アクセス制御

• fileprivate ではなく private を使用
• デフォルトなので internal を追加しない
• 先頭指定子としてアクセス制御を記述

メモリ管理

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

コメント

• 何か ではなく なぜか を説明する
• // または /// を使用し、/* */ は避ける
• 最新に保つか削除する

定数

ネームスペースにはケースなしenum を使用してください:

enum Math {
    static let pi = 3.14159
}

よくある間違い

1. URL、ID以外の略語 — cfg、mgr、ctx、desc のような略語は可読性を損ないます。フルスペルで書いてください: configuration、manager、context、description。3つの例外は URL、ID、UUID です。

2. ネストされた guard/if 文 — 深いネストはコードを読みにくくします。早期リターンと guard を使用して、成功時のパスを左寄せに保ってください。

3. 一貫性のない self 使用法 — self を常に省略するか(推奨)、常に使用するかのいずれかにしてください。混在させるとコード走査が困難になり、キャプチャセマンティクスが混乱します。

4. 過度に汎用的な型名 — Manager、Handler、Helper、Coordinator は曖昧すぎます。名前は責務を説明すべきです: PaymentProcessor、EventDispatcher、ImageCache、NavigationCoordinator。

5. 暗黙的なアクセス制御 — アクセス制御をスキップしないでください。明示的な private、public は将来のメンテナーがモジュール境界を理解するのに役立ちます。internal はデフォルトなので省略してください。