[appledoc]주석을 통한 appledoc로 개발 문서 작성하기.

appledoc git : https://github.com/tomaz/appledoc





설치 순서.

1. 터미널 실행.

  명령어 : git clone https://github.com/tomaz/appledoc.git

2. appledoc 폴더안에 있는 "install-appledoc.sh" 실행. 

명령어 : sudo sh install-appledoc.sh

sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application\ Support/appledoc

3. 도큐먼트를 생성할 프로젝트 폴더에 셋팅 된 AppledocSettings.plist 파일을 넣어두고 실행할 경우 해당 plist속성 대로 파일이 만들어져야 하지만 명령어를 잘못 입력해서인지 파일 생성이 이루어지지 않는다.

명령어로 ignore추가하여 수동 생성하였더니 xCode Document에 해당 프로젝트에 대한 도큐먼트가 생성되었다.

완성된 명령어는 다음과 같다.

appledoc --project-name ????? --project-company ?????? --company-id com.????? —-no-create-docset --ignore ThirdParty --ignore Libraries --ignore Frameworks --ignore ZXingObjC --output ./doc/ .


오류가 있을경우 터미널에 메시지가 나오며, 정상적일 경우 처리중인 프로세스 내용이 나온다.

실행이 완료될 경우 위 그림처럼 문서가 만들어 지는 것을 확인할 수 있다.

xCode에서 Documentation을 생성하는건 프로젝트에서 스크립트를 추가하여 설정이 필요한 것 같다.

내가 원하는건 html로 이루어진 문서이기 때문에 따로 생성할 필요는 없을 것 같다.

그리고 주석이 달려 있을 경우  Appledoc이 설치되어 있지 않더라도 xCode에서 자동완성을 통해 설명이 한글로 나오게 된다.

자세한 사항은 appledoc 홈페이지를 참고하자. 독해만 가능하다면... 해당 사이트에서 원하는 모든 정보를 습득할 수 있을 것이다.

참조 블로그 : 

http://gentlebytes.com/appledoc/

Apple Document Style의 문서를 만들기 (http://hoiogi.tistory.com/archive/201303)

http://www.alterant.kr/2014/11/20/apple-appledoc%EC%9C%BC%EB%A1%9C-%EB%AC%B8%EC%84%9C%ED%99%94documentation-%ED%95%98%EA%B8%B0/