WWDC21: Meet DocC documentation in Xcode のメモ

WWDC21 のセッション 10166: Meet DocC documentation in Xcode を視聴したメモです

概要

XcodeのDocCのドキュメントを紹介する。
DocC とは、 Documentation Compiler の略から来ている。

Swiftのパッケージやフレームワークのためのドキュメントを構築し、共有するためにDocCを使用できる方法を発見してください。あなた自身のコード、またはあなたが依存しているサードパーティのコードからドキュメントを生成し、Markdownを使用してそれを書き、フォーマットする方法を紹介します。また、DocCアーカイブを作成し、一般公開するためのエクスポートプロセスも紹介します。

内容

ドキュメントの生成対象

• Swift Packages
• Frameworks

DocCが提供できるもの

1. リファレンスドキュメント
2. 記事
   • フレームワークの全体像をユーザーに伝えることができ、フレームワークの各項目を一貫したストーリーで結びつけることができる。
3. チュートリアル
   • ユーザーにフレームワークを一から紹介するガイド付き入門書を提供することで、リファレンスドキュメントや記事よりもはるかに深い内容を提供することができる。

ドキュメントの構築方法

Xcode : メニュー項目 [Product] > [Build Documentation]

ドキュメントの構築

ドキュメンテーションウィンドウ

ドキュメントのプレビュー

Swiftフレームワークで作業していて、常にドキュメントをプレビューしながら進めたい場合は、コンパイルするたびにドキュメントをビルドする新しいビルド設定も用意されている。

Xcode : Targets > [Build Settings] タブ > [Documentation Compiler - Options] > [Build Documentation During ‘Build’ ] の設定値を ‘Yes’ にする。

マークダウンを使用した書き方

ダブルバックティックでリンクになる。

``xxx``

ダブルバックティックでリンクになる

エクスポートプロセス

ドキュメンテーションウィンドウからエクスポートできる。
ドキュメンテーションウィンドウのウィンドウナビゲーターにマウスオーバーして、任意の項目にマウスを合わせると、メニューアイコンが表示され、それをクリックすると [Export] オプションがある。

ドキュメンテーションウィンドウに [Export] オプションがある

アーカイブを保存できる

これにより保存したアーカイブをダブルクリックすれば、Xcodeのドキュメンテーションウィンドウが開く。他の人に送ることもできる。

参考

WWDC21 のセッション 10166: Meet DocC documentation in Xcode