* 코드를 작성할 때는 Swift 코딩규약에 따라 작성한다

스위프트 공식 홈페이지에서 마련한 가이드라인은 다음과 같다.
- API Design Guidelines
http://swift.org/documentation/api-design-guidelines/ (새 창으로 열기)

코딩교육사이트로 유명한 raywenderlich.com 에서 제시하는 가이드라인은 다음과 같다. 현재 v4.2 를 기준으로 하고 있다.
- The Official raywenderlich.com Swift Style Guide
http://github.com/raywenderlich/swift-style-guide (새 창으로 열기)
이 가이드라인은 한국어로도 번역되어 있다.
http://kka7.tistory.com/59 (새 창으로 열기)

구글에서 제안하는 스위프트 코딩 규약은 다음 페이지에서 찾을 수 있다.
- Google Swift Style Guide
http://google.github.io/swift/ (새 창으로 열기)

일본의 IT 교육회사에서 사용하고 있는 스위프트 코딩규약도 있다. 2018년 1월 시점
- Swiftコーディング規約@Life is Tech !
http://qiita.com/shinokiryosei/items/9 ··· 6862c706 (새 창으로 열기)

Github에서도 스위프트 코딩스타일에 대한 가이드라인을 마련했는데 2017년 11월 시점으로 업뎃을 중단했다.
- Github guide to Swift style and conventions
http://github.com/github/swift-style-guide (새 창으로 열기)



*규약을 항상 외우고 있을수는 없기 때문에 Lint 플러그인을 사용하여 자동으로 문법오류를 잡도록 하는것이 편리하다. SwiftLint라는  도구가 그 역할을 할 수 있다.
- SwiftLint
http://github.com/realm/SwiftLint (새 창으로 열기)

SwiftLint를 개발한 realm.io의 소개강의가 있다
- SwiftLint로 보다 명확하고 깔끔한 코드를 만들어 보세요!
http://academy.realm.io/kr/posts/slug- ··· tlint%2F (새 창으로 열기)

SwiftLint의 사용법은 다음 페이지에서 상세히 설명하고 있다.
- iOS ) 내 프로젝트에 SwiftLint를 적용해보자
http://zeddios.tistory.com/447 (새 창으로 열기)



* 코드를 깔끔하게 작성했다면 코드를 자동으로 문서화 하는 툴인 Jazzy를 사용할 수 있다.
- Jazzy
http://github.com/realm/jazzy (새 창으로 열기)

realm.io에서 개발한 jazzy를 사용하면 Xcode에서 Markdown 스타일로 작성한 코드를 문서화해준다
- Documenting Your Swift Code in Xcode Using Markdown
http://www.appcoda.com/swift-markdown/ (새 창으로 열기)
- Swift Documentation
http://nshipster.com/swift-documentation/ (새 창으로 열기)

한글로 된 Jazzy의 사용법은 다음 사이트에 나와 있다.
- [Jazzy] Xcode에서 Jazzy를 이용해서 애플 래퍼런스 문서 스타일의 API문서 만들기
http://bitboylabs.wordpress.com/2016/1 ··· 8-api%2F (새 창으로 열기)

가장 최신의 Jazzy 사용설명 페이지는 다음과 같다
- Generate & Host your iOS Documentation
http://medium.com/@jonathan2457/genera ··· 1b382ce8 (새 창으로 열기)
- Swift用ドキュメント生成ツール「Jazzy」のセットアップ&操作方法
http://qiita.com/uhooi/items/d900c2de03e9d9f39b95 (새 창으로 열기)


* jazzy 사용
- gem update --system으로 gem 최신화
- gem install jazzy로 설치
- 인스톨중 퍼미션에러 발생. rootless라는 OSX의 시스템요소때문에 발생한다고 한다
http://stackoverflow.com/questions/328 ··· ermitted (새 창으로 열기)
- sudo gem install -n /usr/local/bin jazzy
- 빌드가 가능한 xcode 디렉토리에서 jazzy --clean --min-acl private를 실행하면 문서가 생성된다.
2019/05/09 20:06 2019/05/09 20:06

Trackback Address :: 이 글에는 트랙백을 보낼 수 없습니다

Comment on this post!