🚀 HMH Swift Style Guide

🔥 코드는 한명이 짠 것처럼 작성하는 것이 목표입니다. SwiftLint는 사용하지 않는 대신, 코드 리뷰를 정성스럽게 해주세요.

1️⃣ Naming

1-1. Class

UpperCamelCase를 사용합니다.

• ViewController, TableViewCell, CollectionViewCell 줄이지 않고 사용

1-2. 변수 및 상수

• 알아볼 수 있는 네이밍을 사용해주세요!

• lowerCamelCase를 사용합니다.

  ex. nameList

1-3. 함수

• 알아볼 수 있는 네이밍 사용하기

• 함수 이름에는 lowerCamelCase를 사용합니다.

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

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

• API 관련 함수는 get, post, put, delete등의 접두사를 사용합니다.

• 좋은 예:

  func backButtonDidTap() {
    // ...
  }

• 나쁜 예:

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

1-4. 열거형

• enum의 이름에는 UpperCamelCase를 사용합니다.

• enum의 각 case에는 lowerCamelCase를 사용합니다.

  좋은 예:

  enum Result {
    case .success
    case .failure
  }
  

  나쁜 예:

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

1-5. 프로토콜

• 프로토콜의 이름에는 UpperCamelCase를 사용합니다.
• Delegate일 경우 Delegate / 이외에는 Protocol 접미사를 사용해주세요

Protocol PickerDelegate { .. }

1-6. 기타 네이밍

• setUI : UI 작성과 관련된 내용을 작성합니다.
  • setHierarchy : 뷰 계층 관계를 작성합니다.
  • setConstraints : 레이아웃 설정 관련 코드를 작성합니다.
• configure~ : 추후에 스타일을 정해야 할 때 사용합니다.
• addTarget : 버튼에 Event를 추가할 때 사용합니다.
• setDelegate : delegate를 설정할 때 사용합니다.

함수 작성 순서

📎 생명 주기 관련 함수 → 커스텀 함수 (레이아웃 우선) → objc 함수

• View 템플릿

  import UIKit
  
  import SnapKit
  import Then
  
  final class MainView: UIView {
  
      override init(frame: CGRect) {
          super.init(frame: frame)
          setUI()
      }
  
      required init?(coder: NSCoder) {
          fatalError("init(coder:) has not been implemented")
      }
  
      func setUI() {
          setHierarchy()
          setConstraints()
      }
  
      func setHierarchy() {
          self.addSubview(scrollView)
      }
  
      func setConstraints() {
          view.snp.makeConstraints {
              $0.edges.equalToSuperview()
          }
      }
  		
  		func configureImageView() {
  				view.backgroundColor = .white
  		 }
  		
  		func addTarget() {
  				button.addTarget(self, action: #selector(backArrowButtonTapped), for: .touchUpInside)
  		}
  }

2️⃣ 코드 레이아웃

2-1.  Protocol 사용 시

extension으로 모두 분리해서 작성해주세요

• 하나의 extension에 프로토콜 하나씩만 적용합니다.

2-2. 임포트

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

import UIKit

import SwiftyColor
import SwiftyImage
import Then
import URLNavigator

2-3. 생명주기(Life Cycle)

생명주기 순서대로 작성해주세요

class MovieRatingViewController: UITableViewController {

  // MARK: - View controller lifecycle methods

  override func viewDidLoad() {
    // ...
  }

  override func viewWillAppear(_ animated: Bool) {
    // ...
  }

  // MARK: - Movie rating manipulation methods

  @objc private func ratingStarWasTapped(_ sender: UIButton?) {
    // ...
  }

  @objc private func criticReviewWasTapped(_ sender: UIButton?) {
    // ...
  }
}

2-4. 줄바꿈

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

  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
  }

빈 줄

• 빈 줄에는 공백이 포함되지 않도록 합니다.

• 모든 파일은 빈 줄로 끝나도록 합니다.

• MARK 구문 위와 아래에는 공백이 필요합니다.

• extension 전에 줄 바꿈은 하나만.

  // MARK: Layout
  
  override func layoutSubviews() {
    // doSomething()
  }
  
  // MARK: Actions
  
  override func menuButtonDidTap() {
    // doSomething()
  }

2-5. self

사용을 지양하고, 오류가 발생할 때 / 꼭 필요할때만 사용해주세요

2-6. 주석

깔끔한 코드 작성을 위해 주석은 최대한 작성하지 않습니다.

3️⃣ 기타

3-1. 프로그래밍 권장사항

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

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

• Literal에 String과 Image를 한 파일로 관리합니다.

  enum ImageLiterals {
      enum NavigationBar {
          static var icArrowLeft: UIImage { .load(named: "ic_back")}
      }
  }

• 상속되지 않는 class는 final class로 선언해주세요

• class 안의 변수들은 private으로 선언해주세요

• 강제 언래핑은 사용을 지양합니다.

참고 Style Share Swift Style Guide