[WWDC21] Meet DocC documentation in Xcode

영상 : https://developer.apple.com/videos/play/wwdc2021/10166/

Meet DocC documentation in Xcode - WWDC21 - Videos - Apple Developer

 

안녕하세요 ◠‿◠ 고고입니다.

DocC(Document Compiler)는 쉽게 말하자면 Apple Developer Documentation처럼 패키지를 문서화할 수 있는 것입니다. Quick Help에서도 볼 수 있습니다.

 

DocC로 Reference, Article, Tutorial을 작성할 수 있습니다.

Reference는 소스코드에 작성한 마크업된 주석이 나타납니다. 

Article은 소개글, 사용법 등의 글에 적합합니다.

Tutorial은 Apple의 swiftUI Tutorial을 생각하시면 됩니다.

 

기본적으로 타겟을 빌드할 때에 DocC는 빌드되지 않지만 DocC를 빌드할 때에는 타겟이 빌드됩니다.

 

Documentation을 빌드하려면

1. Product -> Build Documentation

2. Target -> Build Settings에서 Build Documentation during 'Build'를 허용하면 컴파일할 때마다 문서를 빌드합니다.

3. xcodebuild를 사용한 command line으로도 됩니다.

 

 

이 다음부터는 예제와 함께 설명합니다.

예제의 Documentation을 빌드하면 이렇게 보입니다.

 

슬래시 3개 또는 /** ~ */ 를 입력하고 글을 작성하면 저렇게 Documentation에 표시됩니다. 

첫번째 줄에 작성한 것은 Summary가 됩니다.

 

아래처럼 작성된 문서는 Quick Help에서도 볼 수 있습니다.

```를 통해 문서 안에 코드를 넣을 수 있습니다. 또한 세번째 줄에 작성한 것은 Discussion이 됩니다.

 

메소드의 파라미터와 리턴 타입도 작성할 수 있습니다.

 

Command + 함수를 누르고 Add Documentation을 누르면 손쉽게 문서 작성이 가능합니다.

 

``로 같은 문서 내의 심볼들을 연결할 수 있습니다.

 

 

Xcode의 Help > Developer Documentation 창에서 볼 수 있고 웹에도 올릴 수 있습니다.

 

또, 문서를 추출할 수 있습니다.

.doccarchive라는 확장자의 파일로 나옵니다.

 

끝!