swift_style

Swift スタイル

このスキルでは、クリーンで慣用的、かつ保守しやすい Swift コードを書くための包括的なスタイルガイドラインを紹介します。

概要

Swift のスタイルガイドラインでは、コードをより読みやすく、プロフェッショナルにする命名規則、アクセス制御、型の選択、コード構成のパターンを扱います。

参照資料

命名と規約

• 変数と定数 - var と let の違い、命名規則、不変性
• 関数 - 関数の命名、パラメーターラベル、戻り値の型

型とプロトコル

• 型 - 構造体、クラス、列挙型の違い、値セマンティクスと参照セマンティクス
• プロトコル - プロトコル指向プログラミング（POP）、合成、拡張

コード構成

• アクセス制御 - public、private、internal、fileprivate、open

クイックリファレンス

命名規則

カテゴリー	形式	例
型とプロトコル	UpperCamelCase	String、UIViewController
変数、関数	lowerCamelCase	userID、fetchData()
Boolean プロパティ	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	どこからでも＋サブクラス化可能	拡張可能なフレームワーク

ベストプラクティス

1. デフォルトでは構造体を選ぶ - 意図を表す最もシンプルな型を使います
2. デフォルトでは let を使う - 変更が必要な場合にのみ var を使います
3. 継承よりプロトコルを優先する - より柔軟に合成できます
4. 関数の役割を絞る - 単一責任を守ります
5. アクセス制御を使う - 必要なものだけを公開します
6. 命名規則に従う - 説明的で Swift らしい名前を使います

詳細情報

各参照ファイルには、特定のトピックに関する詳しい情報、コード例、ベストプラクティスが記載されています。包括的な Swift ドキュメントについては、https://swiftzilla.dev をご覧ください。