Ground Rules iOS

iOS Ground Rules

• 특별한 일이 없으면 오프라인으로 만나서 개발 진행 (feat. 스퀘어원 할리스)
• PR의 merge는 상대방이 코드리뷰 후 수행한다 (한마디라도 정성스럽게 코멘트 남기기)
• Trouble Shooting을 작성한다
  • 이슈가 생기면 문제 상황을 먼저 기록한다
  • 해결 과정을 최대한 자세히 기록하고 결론을 간결하게 적는다
  • 가능하면 스크린샷이나 코드를 짧게 기록한다
  • 공동 Notion(피드백은 ♥️입니다 🙌)에 기록하고 이후 위키에 추가한다
• 함께 논의한 // MARK 등을 활용하여 코드 가독성을 높인다
• Naming이나 Convention규칙은 swift api design guideline을 따른다.
• 할고래DO는 Human Interface Guidelines를 준수한다

Coding Convention Rule

아래에 따로 명시하지 않는 내용은 Google Swift Style Guide을 준수한다.

method

• return 앞에 한 줄은 띈다.
  • 단, return 한 줄만 있는 메소드는 예외로 한다.
• 중간에 공백은 의미있는 단위로 구분한다.

func filterCompletedIfNeeded(for displayedTasks: [TaskListModels.DisplayedTask]) -> [TaskListModels.DisplayedTask] {
    guard displayCompleted else {
        return displayedTasks.filter { !$0.isCompleted }
    }
    
    return displayedTasks
}

private extension

• private extension 내부의 메소드에는 private 키워드를 붙이지 않는다.

self

• self 키워드는 필요시에만 명시한다.
  • self 참조가 필요할 때
  • 로컬 변수와 이름이 겹칠 때

guard let

• 조건문이 하나이고 else 문에서 간단한 return만 하는 경우

guard let value = value else { return 0 }

• 조건문이 하나이고 else 문이 길어지는 경우

guard let first = values.first else {
  throw DiscombobulationError.arrayWasEmpty
}

• 조건문이 하나지만 길어질 경우 내려쓸 수 있다.

guard let task = taskList.task(identifier: viewModel.id,
                               postion: viewModel.position,
                               parentPosition: viewModel.parentPosition)
else {
    return
}

• 조건문이 2개 이상인 경우

guard let value = aValueReturnedByAVeryLongOptionalThing(),
      let value2 = aDifferentValueReturnedByAVeryLongOptionalThing()
else { 
  doSomething() 
}

if else

• 조건문이 한 줄일 때,

if let index = index(of: thing, in: lotsOfThings) {
  // Found it.
} else {
  // Didn't find it.
}

• 조건문이 두 줄 이상일 때,

if let index = index(of: thing, in: lotsOfThings),
   condition2 {
  // Found it.
} else {
  // Didn't find it.
}

배치 순서

접근제한자는 다음 순서대로 배치: private - private(set) - internal(생략) - public

// MARK: - Constants

// MARK: - Properties

// MARK: Views

@IBOutlet weak private var addButton: UIButton!
private var label = UILabel()

// MARK: - View Life Cycle

// MARK: - Initialize

// MARK: - Methods

// MARK: Private

// MARK: IBActions

annotation

• 8글자 이하는 한 줄, 그 이상은 두 줄로 사용한다.

@objc func didTappedButton() {

}

@discardableResult
func remove(at index: Int) -> Int {

}

특정 protocol을 채택한 extension에서 메소드 분리가 필요한 경우

• 프로토콜 메소드 하단에 //MARK: - Helper Functions 로 구분해서 배치한다.

protocol을 채택하지 않은 extension

• 특정한 기능을 위한 메소드들이 30줄 이상이면 별도의 extension으로 분리한다. 단, MARK를 통해 기능을 명시한다.
  • 30줄 이하일 때 분리가 필요하다고 판단되면, 팀원과 상의하에 분리할 수 있다.
• 특정 protocol을 채택한 extension보다 위에 배치한다.