iOS) Documentation - Jazzy (1)

Jazzy를 이용한 문서화 후 github page 배포 테스트(Framework) 

Swift로만 이루어진 프로젝트 기준

1. Framework 프로젝트 생성 후 코드 작성

2. 형식에 맞는 문서화를 위한 주석 작성

• 형식은 Swift Documentation에 따름

3. Jazzy 설치

$ gem install jazzy

4. Framework 프로젝트 디렉토리 내에서 jazzy 명령어 입력

$ jazzy

5. docs 내에 생성된 output을 github에 commit, push(gh-pages)

6. <username>.github.io/<repo-name> 으로 접속 후 확인

결과

jazzy를 통해 생성된 output

• Classes에는 문서화한 Class들이 포함됨

Github Page

다음 포스트에서는 다중 프레임워크에 대한 문서를 kakao ios sdk reference처럼 만드는 방법을 알아볼 예정임