iOS Code Convension

Swift Code Style

• raywendlich Style Guide
• SwiftLint 사용

세부 사항

Property

• 최대한 의미가 명확하게 네이밍

Function

• Action Function
  • Button : (Button이름)ButtonTouched
• Closure
  • () -> Void
• setting
  • configure
• 함수의 인자가 긴 경우

func collectionView(_ collectionView: UICollectionView, 
                    layout collectionViewLayout: UICollectionViewLayout,
                    sizeForItemAt indexPath: IndexPath) -> CGSize {
    }

Class & Struct

• Protocol 채택 시에는 extension 후 채택

Protocol

• Providing

주석

• MARK: - : 가독성을 위해 코드가 200줄 이상 등의 긴 ViewController에만 적용.
• TODO: : 해야 할 일 / 개발 해야 할 것들 기록.
• FIXME: : 고쳐야할 버그 작성.

File

• Extension 파일 분리

  • 파일명은 extension된 '객체+' ( ex.DateFormatter+)
  • Common으로 따로 관리

• Struct / Class / Enum 모두 파일 분리

  • 하나의 파일에 여러개의 객체 줄이기 (nested 제외)
  • 코드를 읽는 사람이 잘 찾고, 파일의 의미 전달이 명확하기 위하여

Folder

• UseCase 별로 관련 View, ViewController, Model 등 그룹화