URL: Meet DocC documentation in Xcode - WWDC21 - Videos - Apple Developer
DocC로 만들 수 있는 documentation
- 레퍼런스 문서
- 아티클
- 튜토리얼
Documentation이 빌드되는 과정
Document만 빌드할 경우 스위프트 컴파일러를 거치지 않아도 된다.
Documnet 빌드 하는 방법 3가지
- Product > Build Documentation (⌃⇧⌘D)
- target > Build Settings > Documentation Compiler - Options > Build Documentation during ‘Build’ > Yes
- CLI 툴에서
xcodebuild docbuild
DocC로 Documentation을 잘 쓰는 방법
///이나/** */블록을 쓰는 방법이 있다.//는 documentation이 되지 않는다.
- Mark down 형식을 지원한다.
- method’s declaration과 parameter description을 작성하는 방법
- method documentation 작성하기
Documentation 연결하기
- 더블 백틱을 사용해서 원하는 documentation 링크를 생성할 수 있다.
- 자동완성도 지원한다.
Documentation 공유하기
- Documentation archives
- Open directly in the Xcode documentation window
- Publish to the web
관련 기능들은 https://developer.apple.com/wwdc21/10236 에서 더 자세히 볼 수 있다.
- Xcode에서 바로 Export 할 수 있다
Wrap up
관련 WWDC 영상
Elevate your DocC documentation in Xcode - WWDC21 - Videos - Apple Developer
Great documentation can help people effectively and easily adopt your Swift framework. Discover how you can create rich, conceptual...
Host and automate your DocC documentation - WWDC21 - Videos - Apple Developer
Find out how you can easily host your Swift package and framework DocC documentation online. We'll take you through configuring your web...
Uploaded by N2T