주석 및 문서화에 대해서 천천히 준비를 해야할 것 같다는 생각이 들었다.

주석은 VVDocumenter-Xcode 또는 미리 작성해둔 snippet 을 이용하여 편리하게 작성하기로 했다. (자세한 설명은 Xcode 플러그인 VVDocumenter-Xcode 소개)

문서화의 경우, 목적 자체가 제출보다는 협업이기 때문에 doxygen 보다는 appledoc 을 선택했다.

아래의 링크를 참조하면 쉽게 appledoc 을 추가할 수 있다.

• Using AppleDoc to generate Xcode help (Part 1)
• How to Generate Beautiful Apple-Style Documentation in Xcode 5

설치 및 테스트 과정에서 발생하는 몇 가지 문제는 아래의 링크를 통해 해결할 수 있다.

• Xcode 5 에서 Add Run Script 를 찾을 수가 없다.
  • How to Add a Run Script Build Phase
• .m 에 있는 주석은 문서화가 안 된다.
  • How to document private (non public interface) by using appleDoc?
• Documentation 삭제
  • ~/Library/Developer/Shared/Documentation/DocSets/ 에서 해당 docset 을 삭제

관련 링크

• Amazing Apple-like Documentation