코드를 이해하고 작성하는 데에, 더 도움을 주고 명확하게 소통하기 위한 ComIT의 Swift Style Guide입니다. 코드 리뷰때에서 아래 내용을 바탕으로 신명나게 지적해주세요! 구성원들의 의사결정에 따라 수시로 변경될 수 있습니다.
- 디렉토리 이름은 대문자로 시작하는 단어로 설정합니다.
- 해당 디렉토리에 비슷한 기능을 하는 파일들이 들어있다면 단어의 끝에 복수로
s를 붙여줍니다.-
GOOD👏
- Domains, Entities, Views
-
BAD👎
- Domain, Entity, View
-
- 파일명은
UpperCamelCase를 사용합니다. - 파일명은 줄여서 사용하지 않습니다.
- ViewController, View, ViewModel, Reactor 등 매칭되는 **접두사(prefix)**를 사용합니다.
-
GOOD👏
- HomeViewController.swift - HomeViewModel.swift
-
BAD👎
- HomeVC.swift - HomeVM.swift
-
- class 및 struct의 이름은
UpperCamelCase를 사용합니다.
-
함수 이름에는
lowerCamelCase를 사용합니다. -
함수 이름 앞에는 되록
get과 같은 광범위한 의미를 지닌 단어의 사용을 지양합니다.-
다른 개발자가 읽었을 때 한 번에 이해할 수 있을 만한 함수의 액션을 나타내는 단어를 사용합니다.
-
GOOD👏
func fetchUserInfo() { ... }
-
BAD👎
func getUserInfo() { ... }
-
-
Action 함수의 네이밍은 '주어 + 동사 + 목적어'의 형태를 사용합니다.
- 대표적인 동사로 Tap은 버튼이 눌린 행위, Gesture는 특정 제스쳐가 발생했을 때의 행위, Scroll은 스크롤이 발생했을 때의 행위입니다.
- will~은 특정 행위가 일어나기 직전이고, did~는 특정 행위가 일어난 직후입니다.
- should~은 일반적으로
Bool을 리턴하는 함수에 사용합니다.
- 변수 이름에는
lowerCamelCase를 사용합니다. - 변수 타입 중 Bool타입은 is 와같은 be동사를 접두사를 붙여서 사용합니다.
- 배열 혹은 리스트와 같이 복수의 의미를 담고있는 변수라면 끝에 s를 붙여서 사용합니다.
-
GOOD👏
var images: [Message] = [] var title: String = "" var isValid: Bool = false
-
BAD👎
var image: [Message] = [] var valid: Bool = false
-
- 상수 이름에는
lowerCamelCase를 사용합니다. - 변수 타입 중 Bool타입은 is 와같은 be동사를 접두사를 붙여서 사용합니다.
- 배열 혹은 리스트와 같이 복수의 의미를 담고있는 변수라면 끝에 s를 붙여서 사용합니다.
-
GOOD👏
let horizontalMargin: CGFloat = 40
-
BAD👎
let HORIZONTAL_MARGIN: CGFloat = 40
-
- 열거형 enum 변수들은
lowerCamelCase를 사용합니다.-
GOOD👏
enum MessageType { case text case image case video }
-
BAD👎
enum MessageType { case TEXT case IMAGE case VIDEO }
-
- 약어로 시작하는 변수의 경우 소문자로 시작합니다.
- 약어로 시작하는 class, struct, enum의 경우 대문자료 사용합니다.
- 변수, 클래스 등의 중간에 약어가 들어가는 경우 대문자를 사용합니다.
-
GOOD👏
let html: String let userID: String class URLConvertible {}
-
BAD👎
let HTML: String let userId: String class UrlConvertible {}
-
- 한줄 최대 길이는 100자로 설정합니다.
- XCode > Preferences > Text Editing > Display > Page guide at column에서 설정할 시 편합니다.
- 들여쓰기는 4 spaces로 설정합니다.
- XCode > Preferences > Text Editing > Indentation에서 설정 가능합니다.
-
콜론(:) 뒤에는 띄어쓰기를 사용합니다.
-
GOOD👏
let userID: String
-
BAD👎
let userID : String
-
-
삼항연산자의 경우 (:)의 앞에도 띄어쓰기를 사용합니다.
-
GOOD👏
isLike ? "heart.fill" : "heart"
-
BAD👎
isLike ? "heart.fill": "heart"
-
-
함수를 정의할 때 파라미터 뒤(,)에는 띄어쓰기를 사용합니다
-
GOOD👏
func sum(x: Int, y: Int) -> Int
-
BAD👎
func sum(x: Int,y: Int) -> Int
-
-
연산자 앞뒤로 공백을 추가해서 사용합니다.
-
GOOD👏
let x = 1 + 2
-
BAD👎
let x = 1+2
-
-
함수의 파라미터 혹은 이름이 길어져 100글자를 넘어갈 경우 다음과 같이 줄바꿈합니다
-
GOOD👏
func animationController( forPresented presented: UIViewController, presenting: UIViewController, source: UIViewController ) -> UIViewControllerAnimatedTransitioning? { ... }
-
BAD👎
func animationController(forPresented presented: UIViewController, presenting: UIViewController, source: UIViewController) -> UIViewControllerAnimatedTransitioning? { ... }
-
-
함수를 호출하는 코드가 최대 길이를 초과하는 경우에는 파라미터 이름을 기준으로 줄바꿈합니다.
-
GOOD👏
self.navigationController?.pushViewController( viewController, animated: true )
-
BAD👎
self.navigationController?.pushViewController(viewController, animated: true)
단, 파라미터에 클로저가 2개 이상 존재하는 경우에는 무조건 내려쓰기합니다.
UIView.animate( withDuration: 0.25, animations: { ... }, completion: { finished in ... } )
-
-
배열의 컨텐츠를 정의할 때 길이가 길어진다면 다음과 같이 줄바꿈합니다.
-
GOOD👏
self.addSubViews([ titleLabel, titleButton, nextButton ])
-
BAD👎
self.addSubViews([titleLabel, titleButton, nextButton])
-
-
변수의 네이밍과 타입명이 길어서 정의하는데 100줄이 넘어간다면 다음과 같이 줄바꿈 합니다.
-
GOOD👏
private var myPageTableViewDataSource = RxTableViewSectionedReloadDataSource<MyPageSecionModel>()
-
Bad👎
private var myPageTableViewDataSource = RxTableViewSectionedReloadDataSource<MyPageSecionModel>()
-
-
if let 구문이 길어질 경우에는 쉼표 이후에 줄바꿈을 합니다.
-
GOOD👏
if let user = user, let compete = compete { ... }
-
BAD👎
if let user = user, let compete = compete { ... }
-
-
guard let ... else는 한줄에 표시합니다.-
GOOD👏
guard let user = optionalUser else { return }
-
BAD👎
guard let user = optionalUser else { return }
-
-
guard let구문이 길 경우에는 줄바꿈하고 한 칸 들여씁니다.else는guard와 같은 들여쓰기를 적용합니다.-
GOOD👏
guard let user = optionalUser, let compete = optionalCompete else { return } -
BAD👎
guard let user = optionalUser, let compete = optionalCompete else { return }
-
- 빈 줄에는 공백이 포함되지 않도록 합니다.
- 모든 파일은 빈 줄로 끝나도록 합니다.
- MARK 구문 위와 아래에는 공백이 필요합니다.
-
GOOD👏
// MARK: - Layout override func layoutSubviews() { ... } // MARK: - Actions func menuButtonDidTap() { ... }
-
BAD👎
// MARK: - Layout override func layoutSubviews() { ... } // MARK: - Actions func menuButtonDidTap() { ... }
-
-
switch문 안의 case문은 줄바꿈 후 내용을 정의합니다.
-
case문들 사이에는 한 줄 공백을 추가합니다.
-
GOOD👏
switch user.status { case .success: ... case .failure: ... }
-
BAD👎
switch user.status { case .success: ... case .failure: ... }
-
-
switch문 내부의 case에 파라미터가 있을 경우 let을 맨 앞에 위치 시킵니다.
-
GOOD👏
switch user.status { case let .success(res): ... case let .failure(error): ... }
-
BAD👎
switch user.status { case .success(let res): ... case .failure(let error): ... }
-
-
더이상 상속이 발생하지 않는 클래스는 항상
final키워드로 선언합니다. -
클래스와 구조체 내부에서는
self를 명시적으로 사용합니다. -
단, SwiftUI에서 View를 구성하는데에는 필요치 않는다면
self를 사용하지 않습니다 -
단, 파라미터에 사용할 경우
self를 사용하지 않습니다.- GOOD👏
class ViewController: UIViewController { override func viewDidLoad() { super.viewDidLoad() self.fetchData(user: userName) } }
- BAD👎
class ViewController: UIViewController { override func viewDidLoad() { super.viewDidLoad() fetchData(user: self.userName) } }
- GOOD👏
-
프로토콜을 채택할 경우, 가급적
extension을 사용합니다.-
Good👏
class ViewController: UIViewController { ... } extension ViewController: UITableViewDelegate { ... }
-
Bad👎
class ViewController: UIViewController, UITableViewDelegate { ... }
-
-
파라미터와 리턴 타입이 없는 Closure 정의시에는
() -> Void를 사용합니다.-
GOOD👏
let completionBlock: (() -> Void)?
-
BAD👎
let completionBlock: (() -> ())? let completionBlock: ((Void) -> (Void))?
-
-
클로저 내의 파라미터에는 괄호를 사용하지 않습니다.
-
GOOD👏
let closure = { arg1, arg2 in ... }
-
BAD👎
let closure = { (arg1, arg2) in ... }
-
-
Closure 정의시 가능한 경우 타입 정의를 생략합니다.
-
GOOD👏
let closure = { arg1 in ... }
-
BAD👎
let closure = { (arg1: String) in ... }
-
-
사용하지 않는 클로저 파라미터는
_로 선언합니다.-
GOOD👏
let closure = { _, arg2 in print(arg2) }
-
BAD👎
let closure = { (arg1, arg2) in pring(arg2) }
-
-
Closure 호출시 또다른 유일한 Closure를 마지막 파라미터로 받는 경우, 파라미터 이름을 생략합니다.
-
GOOD👏
UIView.animate(withDuration: 0.5) { ... }
-
BAD👎
UIView.animate(withDuration: 0.5, animations: { () -> Void in ... })
-
s## 주석
-
문서화를 할 경우
///을 사용합니다.-
GOOD👏
/// 사용자 프로필을 그려주는 뷰 class ProfileView: UIView { /// 사용자 닉네임을 그려주는 라벨 var nameLabel: UILabel! }
-
BAD👎
// 사용자 프로필을 그려주는 뷰 class ProfileView: UIView { // MARK: 사용자 닉네임을 그려주는 라벨 var nameLabel: UILabel }
-
-
// MARK: -또는// MARK:를 사용해서 연관된 코드를 구분짓습니다. -
// MARK: -는 대제목,// MARK:는 소제목격으로 구분짓습니다.-
GOOD👏
// MARK: - Properties private let profileImageView = UIImageView() // MARK: - init init() { ... }
-
BAD👎
// MARK: Properties private let profileImageView = UIImageView() // MARK: init init() { ... }
-
-
상수를 정의할 때에는
enum를 만들어 비슷한 상수끼리 모아둡니다. 재사용성과 유지보수 측면에서 큰 향상을 가져옵니다.struct대신enum을 사용하는 이유는, 생성자가 제공되지 않는 자료형을 사용하기 위해서입니다. -
final class ProfileViewController: UIViewController { private enum Metric { static let profileImageViewLeft: CGFloat = 10 static let profileImageViewRight: CGFloat = 10 static let nameLabelTopBottom: CGFloat = 8 static let bioLabelTop: CGFloat = 6 } private enum Font { static let nameLabel = UIFont.boldSystemFont(ofSize: 14) static let bioLabel = UIFont.boldSystemFont(ofSize: 12) } private enum Color { static let nameLabelText = UIColor(hex: 0x000000) static let bioLabelText = UIColor(hex: 0x333333) } }
이렇게 선언된 상수들은 다음과 같이 사용될 수 있습니다.
self.profileImageView.frame.origin.x = Metric.profileImageViewLeft self.nameLabel.font = Font.nameLabel self.nameLabel.textColor = Color.nameLabelText
-
일반적인 변수, 함수의 선언 순서는 아래와 같습니다.
- 상수
- 변수
- 생성자 및 소멸자
- override 함수
- public 함수
- private 함수