• Xcode 13에 새로 나온 피쳐
• Overview
  • Xcode 13부터는 프레임워크와 패키지의 문서도 컴파일 할 수 있다.
  • 이를 위한 컴파일러가 DocC(Documentation Compiler)다.
  • 퀵헬프, 자동완성, 개발자 문서를 자동으로 만들어준다.
  • DocC가 제공하는 문서 포맥
    • 레퍼런스 문서를 만들어줘서, 좀 더 거시적인 관점으로 프레임워크/패키지를 볼 수 있게 한다.
    • 아티클을 만들어서, 프레임워크의 스토리를 설명할 수도 있다.
    • 튜토리얼을 제공할 수도 있다.
  • 오픈 소스로 공개할 예정
• Building and browsing
  • 빌드 과정에서 Public API에 대한 정보를 저장하고 싶다고 하면, 이를 DocC에 넘긴다.
    • build옵션에서 build Documentation During Build 옵션을 켜준다.
    • xcodebuild CLI 툴에서도 docbuild 서브 커맨드를 주면 DocC를 사용할 수 있다.
    • 개별적으로는 Product - Build Documentation을 쓰면 된다. 이러면 뷰어가 자동으로 뜬다.
  • DocC는 문서 카달로그와 위에서 받은 정보를 가지고 빌드 한다.
• authoring
  • in-source 문서화를 지원하기 위한 속성. 기존에 있던 in-source documentation 문법을 그대로 사용한다.
  • 슬래시 3개로 시작하는 구문을 컴파일한다. 두개는 그냥 주석일 뿐
  • 혹은 *표 두개로 시작하는 주석도 된다.
  • Public API에 대해서만 DocC가 동작한다
  • 마크다운 문법을 지원한다. 코드 블록 같은 것도 쉽게 넣을 수 있다.
  • 첫줄은 overview, 빈라인으로 구분한 이후부터는 description
  • Parameter와 return값은 -parameter와 -return으로 구분
  • 메뉴로 템플릿을 자동으로 만들어주는 기능을 지원한다.

// style 1
/**
*/

// style 2
///

• 링크 기능(새로 추가)
  • 단일 백틱으로 감싸면 강조만 해준다.
  • 디렉토리 스타일로 구조화 가능

/// You can increase the sloth's energy level by asking them to ``eat(_: quantity:)``
/// or ``sleep(in:for:)``

• sharing
  • 웹으로도 호스팅 가능 → Host and automate 관련 세션 참조
  • 로컬 export 가능 → docarchive 확장자