Jazzy로 모듈 문서화를 해봅시다. 🎶

프로젝트를 하다보면 여러 모듈을 생성하고, 이를 문서화해 팀원들 및 인수인계 시 공유할 일이 많습니다.

모듈을 문서화하기 위한 대표적인 툴로 Jazzy가 있습니다.

 

하지만 유의해야할 점은, 문서화를 하기에 앞서 코드 상으로 꼭 '주석처리'를 규칙에 맞게 해줘야한다는 점입니다.

규격에 맞게 주석을 작성해놔야, Jazzy가 이를 인식하고 문서화를 해주는 원리입니다.

 

어떻게 작성하냐고요?

갓지피티한테 'Jazzy로 문서화할 건데 이에 맞게 이 코드에 대한 주석을 작성해줘.'라고 하면 다 해줍니다. ㅋㅋ

 

 

일단 Jazzy로 문서화를 하는 방법을 알아보죠!

Jazzy 설치

 sudo gem install jazzy

 

 

스크립트 작성
프로젝트의 루트 디렉토리로 가서 해당 스크립트를 작성합니다.

jazzy \
> --module [모듈이름] \
> --xcodebuild-arguments -project,"[프로젝트이름].xcodeproj",-scheme,"
[모듈이름]"

 

문서 확인

위 스크립트가 제대로 실행이 됐다면, docs 폴더가 생성되며 안에 index.html 문서 또한 생겼습니다.

index.html파일을 열어봅니다.

open docs/index.html

문서가 순식간에 생성된 것을 확인할 수 있습니다.

 

 

이렇게 간편하게 생성한 문서를 서버에 띄워 팀원들에게 공유하면 참 좋겠죠.

서버 팀원에게 이걸 서버에 띄워달라고 부탁하거나,

저 같은 경우는 간단하게 Github Pages로 배포하는 것을 애용하는 편입니다.