# Swift 코딩규약

Swift 코드를 작성할 때는 코딩규약에 따라 작성하는게 추천되는데, 여러 조직에서 이 규약을 제공하고 있다.

• 스위프트 공식 홈페이지의 API Design Guidelines

• raywenderlich.com 의 The Official raywenderlich.com Swift Style Guide

• The Official raywenderlich.com Swift Style Guide는 한국어로도 번역되어 있다.

• Google Swift Style Guide

• 일본의 IT 교육회사에서 사용하는 규약 Swiftコーディング規約@Life is Tech !

• Github에서도 Github guide to Swift style and conventions를 제공하고 있었으나 2017년 11월 시점으로 업뎃을 중단했다.

# Lint 사용

규약을 항상 외우고 있을수는 없기 때문에 Lint 플러그인을 사용하여 자동으로 문법오류를 잡도록 하는것이 편리하다. SwiftLint라는 도구가 그 역할을 할 수 있다.

SwiftLint의 사용법에 대해서는 SwiftLint로 보다 명확하고 깔끔한 코드를 만들어 보세요!를 참고하도록 하자.

SwiftLint의 실제 사용법은 갓제드님의 iOS ) 내 프로젝트에 SwiftLint를 적용해보자를 참고하도록 하자.

# Jazzy로 코드 문서화하기

코드를 깔끔하게 작성했다면 코드를 자동으로 문서화 하는 툴인 Jazzy를 사용할 수 있다.

realm.io에서 개발한 jazzy를 사용하면 Xcode에서 Markdown 스타일로 작성한 코드를 문서화해준다. 포맷에 대해서는 Documenting Your Swift Code in Xcode Using Markdown 이나, Swift Documentation을 참고하자.

한글로 된 Jazzy의 사용법에 대해서는 Xcode에서 Jazzy를 이용해서 애플 래퍼런스 문서 스타일의 API문서 만들기를 참고하자. 가장 최신의 Jazzy 사용법은 Generate & Host your iOS Documentation, Swift用ドキュメント生成ツール「Jazzy」のセットアップ&操作方法에서 확인할 수 있다.

# jazzy 사용

• gem update --system으로 gem 최신화
• gem install jazzy 로 설치
• 인스톨중 (Errno::EPERM) Operation not permitted 에러가 발생할 수 있는데, rootless라는 OSX의 시스템요소때문에 발생한다고 하니 stackoverflow를 참고하여 해결하자.
• sudo gem install -n /usr/local/bin jazzy
• 빌드가 가능한 xcode 디렉토리에서 jazzy --clean --min-acl private를 실행하면 문서가 생성된다.