KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

swift-style-guide

★ 583 Open GitHub ↗

StyleShare에서 작성한 Swift 한국어 스타일 가이드

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Swift Style Guide
=================

![Swift](https://img.shields.io/badge/Swift-4.2-orange.svg)
[![Creative Commons License](https://img.shields.io/badge/license-CC--BY--4.0-blue.svg)](http://creativecommons.org/licenses/by/4.0/)

StyleShare 구성원들이 Swift 코드를 이해하기 쉽고 명확하게 작성하기 위한 스타일 가이드입니다. 구성원들의 의사결정에 따라 수시로 변경될 수 있습니다.

본 문서에 나와있지 않은 규칙은 아래 문서를 따릅니다.

- [Swift API Design Guidelines](https://swift.org/documentation/api-design-guidelines)
- [SE-0005](https://github.com/apple/swift-evolution/blob/master/proposals/0005-objective-c-name-translation.md)

## 목차

- [코드 레이아웃](#코드-레이아웃)
  - [들여쓰기 및 띄어쓰기](#들여쓰기-및-띄어쓰기)
  - [줄바꿈](#줄바꿈)
  - [최대 줄 길이](#최대-줄-길이)
  - [빈 줄](#빈-줄)
  - [임포트](#임포트)
- [네이밍](#네이밍)
  - [클래스와 구조체](#클래스와-구조체)
  - [함수](#함수)
  - [변수](#변수)
  - [상수](#상수)
  - [열거형](#열거형)
  - [프로토콜](#프로토콜)
  - [약어](#약어)
  - [Delegate](#delegate)
- [클로저](#클로저)
- [클래스와 구조체](#클래스와-구조체)
- [타입](#타입)
- [주석](#주석)
- [프로그래밍 권장사항](#프로그래밍-권장사항)

## 코드 레이아웃

### 들여쓰기 및 띄어쓰기

- 들여쓰기에는 탭(tab) 대신 2개의 space를 사용합니다.
- 콜론(`:`)을 쓸 때에는 콜론의 오른쪽에만 공백을 둡니다.

```swift
    let names: [String: String]?
    ```

- 연산자 오버로딩 함수 정의에서는 연산자와 괄호 사이에 한 칸 띄어씁니다.

```swift
    func ** (lhs: Int, rhs: Int)
    ```

### 줄바꿈

- 함수 정의가 최대 길이를 초과하는 경우에는 아래와 같이 줄바꿈합니다.

```swift
    func collectionView(
      _ collectionView: UICollectionView,
      cellForItemAt indexPath: IndexPath
    ) -> UICollectionViewCell {
      // doSomething()
    }

func animationController(
      forPresented presented: UIViewController,
      presenting: UIViewController,
      source: UIViewController
    ) -> UIViewControllerAnimatedTransitioning? {
      // doSomething()
    }
    ```

- 함수를 호출하는 코드가 최대 길이를 초과하는 경우에는 파라미터 이름을 기준으로 줄바꿈합니다.

```swift
    let actionSheet = UIActionSheet(
      title: "정말 계정을 삭제하실 건가요?",
      delegate: self,
      cancelButtonTitle: "취소",
      destructiveButtonTitle: "삭제해주세요"
    )
    ```

단, 파라미터에 클로저가 2개 이상 존재하는 경우에는 무조건 내려쓰기합니다.

```swift
    UIView.animate(
      withDuration: 0.25,
      animations: {
        // doSomething()
      },
      completion: { finished in
        // doSomething()
      }
    )
    ```

- `if let` 구문이 길 경우에는 줄바꿈하고 한 칸 들여씁니다.

```swift
    if let user = self.veryLongFunctionNameWhichReturnsOptionalUser(),
       let name = user.veryLongFunctionNameWhichReturnsOptionalName(),
      user.gender == .female {
      // ...
    }
    ```
    
- `guard let` 구문이 길 경우에는 줄바꿈하고 한 칸 들여씁니다. `else`는 `guard`와 같은 들여쓰기를 적용합니다.

```swift
    guard let user = self.veryLongFunctionNameWhichReturnsOptionalUser(),
          let name = user.veryLongFunctionNameWhichReturnsOptionalName(),
          user.gender == .female
    else {
      return
    }
    ```

### 최대 줄 길이

- 한 줄은 최대 99자를 넘지 않아야 합니다.

Xcode의 **Preferences → Text Editing → Display**의 'Page guide at column' 옵션을 활성화하고 99자로 설정하면 편리합니다.

### 빈 줄

- 빈 줄에는 공백이 포함되지 않도록 합니다.
- 모든 파일은 빈 줄로 끝나도록 합니다.
- MARK 구문 위와 아래에는 공백이 필요합니다.

```swift
    // MARK: Layout

override func layoutSubviews() {
      // doSomething()
    }

// MARK: Actions

override func menuButtonDidTap() {
      // doSomething()
    }
    ```
    
### 임포트

모듈 임포트는 알파벳 순으로 정렬합니다. 내장 프레임워크를 먼저 임포트하고, 빈 줄로 구분하여 서드파티 프레임워크를 임포트합니다.

```swift
import UIKit

import SwiftyColor
import SwiftyImage
import Then
import URLNavigator
```

## 네이밍

### 클래스와 구조체

- 클래스와 구조체의 이름에는 UpperCamelCase를 사용합니다.
- 클래스 이름에는 접두사Prefix를 붙이지 않습니다.

**좋은 예:**

```swift
  class SomeClass {
    // class definition goes here
  }

struct SomeStructure {
    // structure definition goes here
  }
  ```

**나쁜 예:**

```swift
  class someClass {
  // class definition goes here
  }

struct someStructure {
  // structure definition goes here
  }
  ```

### 함수

- 함수 이름에는 lowerCamelCase를 사용합니다.
- 함수 이름 앞에는 되도록이면 `get`을 붙이지 않습니다.

**좋은 예:**

```swift
    func name(for user: User) -> String?
    ```

**나쁜 예:**

```swift
    func getName(for user: User) -> String?
    ```

- Action 함수의 네이밍은 '주어 + 동사 + 목적어' 형태를 사용합니다.

- *Tap(눌렀다 뗌)*은 `UIControlEvents`의 `.touchUpInside`에 대응하고, *Press(누름)*는 `.touchDown`에 대응합니다.
    - *will~*은 특정 행위가 일어나기 직전이고, *did~*는 특정 행위가 일어난 직후입니다.
    - *should~*는 일반적으로 `Bool`을 반환하는 함수에 사용됩니다.

**좋은 예:**

```swift
    func backButtonDidTap() {
      // ...
    }
    ```

**나쁜 예:**

```swift
    func back() {
      // ...
    }

func pressBack() {
      // ...
    }
    ```

### 변수

- 변수 이름에는 lowerCamelCase를 사용합니다.

### 상수

- 상수 이름에는 lowerCamelCase를 사용합니다.

**좋은 예:**

```swift
    let maximumNumberOfLines = 3
    ```

**나쁜 예:**

```swift
    let MaximumNumberOfLines = 3
    let MAX_LINES = 3
    ```
    
### 열거형

- enum의 이름에는 UpperCamelCase를 사용합니다.
- enum의 각 case에는 lowerCamelCase를 사용합니다.

**좋은 예:**

```swift
  enum Result {
    case .success
    case .failure
  }
  ```

**나쁜 예:**

```swift
  enum Result {
    case .Success
    case .Failure
  }

enum result {
    case .Success
    case .Failure
  }
  ```

### 프로토콜

- 프로토콜의 이름에는 UpperCamelCase를 사용합니다.
- 구조체나 클래스에서 프로토콜을 채택할 때는 콜론과 빈칸을 넣어 구분하여 명시합니다.
- extension을 통해 채택할 때도 동일하게 적용됩니다.

**좋은 예:**

```swift
  protocol SomeProtocol {
    // protocol definition goes here
  }

struct SomeStructure: SomeProtocol, AnotherProtocol {
    // structure definition goes here
  }

class SomeClass: SomeSuperclass, SomeProtocol, AnotherProtocol {
      // class definition goes here
  }

extension UIViewController: SomeProtocol, AnotherProtocol {
    // doSomething()
  }
  ```

### 약어

- 약어로 시작하는 경우 소문자로 표기하고, 그 외의 경우에는 항상 대문자로 표기합니다.

**좋은 예:**

<pre>
 let userID: Int?
 let html: String?
 let websiteURL: URL?
 let urlString: String?
 </pre>

**나쁜 예:**

<pre>
 let userId: Int?
 let HTML: String?
 let websiteUrl: NSURL?
 let URLString: String?
 </pre>

### Delegate

- Delegate 메서드는 프로토콜명으로 네임스페이스를 구분합니다.

**좋은 예:**

```swift
    protocol UserCellDelegate {
      func userCellDidSetProfileImage(_ cell: UserCell)
      func userCell(_ cell: UserCell, didTapFollowButtonWith user: User)
    }
    ```

**나쁜 예:**

```swift
    protocol UserCellDelegate {
      func didSetProfileImage()
      func followPressed(user: User)

// `UserCell`이라는 클래스가 존재할 경우 컴파일 에러 발생
      func UserCell(_ cell: UserCell, didTapFollowButtonWith user: User)
    }
    ```

## 클로저

- 파라미터와 리턴 타입이 없는 Closure 정의시에는 `() -> Void`를 사용합니다.

**좋은 예:**

```swift
    let completionBlock: (() -> Void)?
    ```

**나쁜 예:**

```swift
    let completionBlock: (() -> ())?
    let completionBlock: ((Void) -> (Void))?
    ```

- Closure 정의시 파라미터에는 괄호를 사용하지 않습니다.

**좋은 예:**

```swift
    { operation, responseObject in
      // doSomething()
    }
    ```

**나쁜 예:**

```swift
    { (operation, responseObject) in
      // doSomething()
    }
    ```

- Closure 정의시 가능한 경우 타입 정의를 생략합니다.

**좋은 예:**

```swift
    ...,
    completion: { finished in
      // doSomething()
    }
    ```

**나쁜 예:**

```swift
    ...,
    completion: { (finished: Bool) -> Void in
      // doSomething()
    }
    ```

- Closure 호출시 또다른 유일한 Closure를 마지막 파라미터로 받는 경우, 파라미터 이름을 생략합니다.

**좋은 예:**

```swift
    UIView.animate(withDuration: 0.5) {
      // doSomething()
    }
    ```

**나쁜 예:**

```swift
    UIView.animate(withDuration: 0.5, animations: { () -> Void in
      // doSomething()
    })
    ```

## 클래스와 구조체

- 클래스와 구조체 내부에서는 `self`를 명시적으로 사용합니다.
- 구조체를 생성할 때에는 Swift 구조체 생성자를 사용합니다.

**좋은 예:**

```swift
    let frame = CGRect(x: 0, y: 0, width: 100, height: 100)
    ```

**나쁜 예:**

```swift
    let frame = CGRectMake(0, 0, 100, 100)
    ```

## 타입

- `Array<T>`와 `Dictionary<T: U>` 보다는 `[T]`, `[T: U]`를 사용합니다.

**좋은 예:**

```swift
    var messages: [String]?
    var names: [Int: String]?
    ```

**나쁜 예:**

```swift
 var messages: Array<String>?
 var names: Dictionary<Int, String>?
 ```

## 주석

- `///`를 사용해서 문서화에 사용되는 주석을 남깁니다.

```swift
    /// 사용자 프로필을 그려주는 뷰
    class ProfileView: UIView {

/// 사용자 닉네임을 그려주는 라벨
      var nameLabel: UILabel!
    }
    ```

- `// MARK:`를 사용해서 연관된 코드를 구분짓습니다.

Objective-C에서 제공하는 `#pragma mark`와 같은 기능으로, 연관된 코드와 그렇지 않은 코드를 구분할 때 사용합니다.

```swift
    // MARK: Init

override init(frame: CGRect) {
      // doSomething()
    }

deinit {
      // doSomething()
    }

// MARK: Layout

override func layoutSubviews() {
      // doSomething()
    }

// MARK: Actions

override func menuButtonDidTap() {
      // doSomething()
    }
    ```

## 프로그래밍 권장사항

- 가능하다면 변수를 정의할 때 함께 초기화하도록 합니다. [Then](https://github.com/devxoul/Then)을 사용하면 초기화와 함께 속성을 지정할 수 있습니다.

```swift
    let label = UILabel().then {
      $0.textAlignment = .center
      $0.textColor = .black
      $0.text = "Hello, World!"
    }
    ```

- 상수를 정의할 때에는 `enum`를 만들어 비슷한 상수끼리 모아둡니다. 재사용성과 유지보수 측면에서 큰 향상을 가져옵니다. `struct` 대신 `enum`을 사용하는 이유는, 생성자가 제공되지 않는 자료형을 사용하기 위해서입니다. [CGFloatLiteral](https://github.com/devxoul/CGFloatLiteral)과 [SwiftyColor](https://github.com/devxoul/SwiftyColor)를 사용해서 코드를 단순화시킵니다.

```swift
    final class ProfileViewController: UIViewController {

private enum Metric {
        static let profileImageViewLeft = 10.f
        static let profileImageViewRight = 10.f
        static let nameLabelTopBottom = 8.f
        static let bioLabelTop = 6.f
      }

private enum Font {
        static let nameLabel = UIFont.boldSystemFont(ofSize: 14)
        static let bioLabel = UIFont.boldSystemFont(ofSize: 12)
      }

private enum Color {
        static let nameLabelText = 0x000000.color
        static let bioLabelText = 0x333333.color ~ 70%
      }

}
    ```

이렇게 선언된 상수들은 다음과 같이 사용될 수 있습니다.

```swift
    self.profileImageView.frame.origin.x = Metric.profileImageViewLeft
    self.nameLabel.font = Font.nameLabel
    self.nameLabel.textColor = Color.nameLabelText
    ```

- 더이상 상속이 발생하지 않는 클래스는 항상 `final` 키워드로 선언합니다.

- 프로토콜을 적용할 때에는 extension을 만들어서 관련된 메서드를 모아둡니다.

**좋은 예**:

```swift
    final class MyViewController: UIViewController {
      // ...
    }

// MARK: - UITableViewDataSource

extension MyViewController: UITableViewDataSource {
      // ...
    }

// MARK: - UITableViewDelegate

extension MyViewController: UITableViewDelegate {
      // ...
    }
    ```

**나쁜 예**:

```swift
    final class MyViewController: UIViewController, UITableViewDataSource, UITableViewDelegate {
      // ...
    }
    ```

## 라이센스

swift-style-guide

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README