Ounce_Coding_Convention

Jump to bottom

Junhyeon edited this page Jun 30, 2020 · 2 revisions

Ounce

Coding-Convention

Style Share의 swift-style-guide 문서를 참고해 만든 문서입니다.

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

본 문서에 나와있지 않은 규칙은 아래 문서를 따릅니다.
- Swift API Design Guidelines
- SE-0005
목차
코드 레이아웃

들여쓰기 및 띄어쓰기
- 들여쓰기에는 탭(tab)을 사용합니다
- 콜론(:)을 쓸 때에는 콜론의 오른쪽에만 공백을 둡니다.
```
let names: [String: String]?
```
- 연산자 오버로딩 함수 정의에서는 연산자와 괄호 사이에 한 칸 띄어씁니다.
```
func ** (lhs: Int, rhs: Int)
```
줄바꿈
- 함수 정의가 최대 길이를 초과하는 경우에는 아래와 같이 줄바꿈합니다.
```
func collectionView(
  _ collectionView: UICollectionView,
  cellForItemAt indexPath: IndexPath
) -> UICollectionViewCell {
  // doSomething()
}

func animationController(
  forPresented presented: UIViewController,
  presenting: UIViewController,
  source: UIViewController
) -> UIViewControllerAnimatedTransitioning? {
  // doSomething()
}
```
- 함수를 호출하는 코드가 최대 길이를 초과하는 경우에는 파라미터 이름을 기준으로 줄바꿈합니다.
```
let actionSheet = UIActionSheet(
  title: "정말 계정을 삭제하실 건가요?",
  delegate: self,
  cancelButtonTitle: "취소",
  destructiveButtonTitle: "삭제해주세요"
)
```
  단, 파라미터에 클로저가 2개 이상 존재하는 경우에는 무조건 내려쓰기합니다.
```
UIView.animate(
  withDuration: 0.25,
  animations: {
    // doSomething()
  },
  completion: { finished in
    // doSomething()
  }
)
```
- if let 구문이 길 경우에는 줄바꿈하고 한 칸 들여씁니다.
```
if let user = self.veryLongFunctionNameWhichReturnsOptionalUser(),
  let name = user.veryLongFunctionNameWhichReturnsOptionalName(),
  user.gender == .female {
  // ...
}
```
- guard let 구문이 길 경우에는 줄바꿈하고 한 칸 들여씁니다. else는 guard와 같은 들여쓰기를 적용합니다.
```
guard let user = self.veryLongFunctionNameWhichReturnsOptionalUser(),
  let name = user.veryLongFunctionNameWhichReturnsOptionalName(),
  user.gender == .female
else {
  return
}
```
최대 줄 길이
- 한 줄은 최대 99자를 넘지 않아야 합니다.
  
  Xcode의 Preferences → Text Editing → Editing의 'Page guide at column' 옵션을 활성화하고 99자로 설정하면 편리합니다.
빈 줄
- 빈 줄에는 공백이 포함되지 않도록 합니다.
- 모든 파일은 빈 줄로 끝나도록 합니다.
- MARK 구문 위와 아래에는 공백이 필요합니다.
```
// MARK: Layout

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

// MARK: Actions

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

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

import SwiftyColor
import SwiftyImage
import Then
import URLNavigator
```
네이밍

클래스
- 클래스 이름에는 UpperCamelCase를 사용합니다.
- 클래스 이름에는 접두사^Prefix를 붙이지 않습니다.
함수
- 함수 이름에는 lowerCamelCase를 사용합니다.
- 함수 이름 앞에는 되도록이면 get을 붙이지 않습니다.
  
  좋은 예:
```
func name(for user: User) -> String?
```
  나쁜 예:
```
func getName(for user: User) -> String?
```
- Action 함수의 네이밍은 '주어 + 동사 + 목적어' 형태를 사용합니다.
  - *Tap(눌렀다 뗌)*은 UIControlEvents의 .touchUpInside에 대응하고, *Press(누름)*는 .touchDown에 대응합니다.
  - will~은 특정 행위가 일어나기 직전이고, did~는 특정 행위가 일어난 직후입니다.
  - should~는 일반적으로 Bool을 반환하는 함수에 사용됩니다.
  좋은 예:
```
func backButtonDidTap() {
  // ...
}
```
  나쁜 예:
```
func back() {
  // ...
}

func pressBack() {
  // ...
}
```
변수
- 변수 이름에는 lowerCamelCase를 사용합니다.
상수
- 상수 이름에는 lowerCamelCase를 사용합니다.
  
  좋은 예:
```
let maximumNumberOfLines = 3
```
  나쁜 예:
```
let kMaximumNumberOfLines = 3
let MAX_LINES = 3
```
열거형
- enum의 각 case에는 lowerCamelCase를 사용합니다.
  
  좋은 예:
```
enum Result {
  case .success
  case .failure
}
```
  나쁜 예:
```
enum Result {
  case .Success
  case .Failure
}
```
약어
- 약어로 시작하는 경우 소문자로 표기하고, 그 외의 경우에는 항상 대문자로 표기합니다.
  
  좋은 예:
```
let userID: Int?
let html: String?
let websiteURL: URL?
let urlString: String?
```
  나쁜 예:
```
let userId: Int?
let HTML: String?
let websiteUrl: NSURL?
let URLString: String?
```
클래스와 구조체
- 클래스와 구조체 내부에서는 self를 명시적으로 사용합니다.
- 구조체를 생성할 때에는 Swift 구조체 생성자를 사용합니다.
  
  좋은 예:
```
let frame = CGRect(x: 0, y: 0, width: 100, height: 100)
```
  나쁜 예:
```
let frame = CGRectMake(0, 0, 100, 100)
```
타입
- Array<T>와 Dictionary<T: U> 보다는 [T], [T: U]를 사용합니다.
  
  좋은 예:
```
var messages: [String]?
var names: [Int: String]?
```
  나쁜 예:
```
var messages: Array<String>?
var names: Dictionary<Int, String>?
```
주석
- ///를 사용해서 문서화에 사용되는 주석을 남깁니다.
```
/// 사용자 프로필을 그려주는 뷰
class ProfileView: UIView {

    /// 사용자 닉네임을 그려주는 라벨
    var nameLabel: UILabel!
}
```
- // MARK:를 사용해서 연관된 코드를 구분짓습니다.
  
  Objective-C에서 제공하는 #pragma mark와 같은 기능으로, 연관된 코드와 그렇지 않은 코드를 구분할 때 사용합니다.
```
// MARK: Init

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

deinit {
  // doSomething()
}
```
  // MARK: Layout
  
  override func layoutSubviews() { // doSomething() }
  
  // MARK: Actions
  
  override func menuButtonDidTap() { // doSomething() }
프로그래밍 권장사항
- 가능하다면 변수를 정의할 때 함께 초기화하도록 합니다. Then을 사용하면 초기화와 함께 속성을 지정할 수 있습니다.
```
let label = UILabel().then {
  $0.textAlignment = .center
  $0.textColor = .black
  $0.text = "Hello, World!"
}
```
- 상수를 정의할 때에는 enum를 만들어 비슷한 상수끼리 모아둡니다. 재사용성과 유지보수 측면에서 큰 향상을 가져옵니다. struct 대신 enum을 사용하는 이유는, 생성자가 제공되지 않는 자료형을 사용하기 위해서입니다. CGFloatLiteral과 SwiftyColor를 사용해서 코드를 단순화시킵니다.
```
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%
  }

}
```
  이렇게 선언된 상수들은 다음과 같이 사용될 수 있습니다.
```
self.profileImageView.frame.origin.x = Metric.profileImageViewLeft
self.nameLabel.font = Font.nameLabel
self.nameLabel.textColor = Color.nameLabelText
```
- 더이상 상속이 발생하지 않는 클래스는 항상 final 키워드로 선언합니다.
- 프로토콜을 적용할 때에는 extension을 만들어서 관련된 메서드를 모아둡니다.
  
  좋은 예:
```
final class MyViewController: UIViewController {
  // ...
}

// MARK: - UITableViewDataSource

extension MyViewController: UITableViewDataSource {
  // ...
}

// MARK: - UITableViewDelegate

extension MyViewController: UITableViewDelegate {
  // ...
}
```
  나쁜 예:
```
final class MyViewController: UIViewController, UITableViewDataSource, UITableViewDelegate {
  // ...
}
```
라이센스

본 문서는 크리에이티브 커먼즈 저작자표시 4.0 국제 라이센스에 따라 이용할 수 있으며, 저작권은 전수열과 StyleShare에게 있습니다.