swift-docc

docc

Swift のフレームワークやパッケージ向けに、充実した API リファレンスドキュメントとインタラクティブなチュートリアルを作成します。

ドキュメントの構成

基本

• Swift フレームワークまたはパッケージのドキュメント作成 (documenting-a-swift-framework-or-package.md): ソース内のコメントから開発者向けドキュメントを作成し、コードスニペットを含む記事を追加します。

ドキュメントのコンテンツ

• ソースファイルでシンボルのドキュメントを作成する (writing-symbol-documentation-in-your-source-files.md): シンボルの使い方を説明するリファレンスドキュメントを追加します。
• ドキュメントカタログに補足コンテンツを追加する (adding-supplemental-content-to-a-documentation-catalog.md): 記事や拡張ファイルを含めて、ソースのドキュメントコメントを拡張したり、概念を補足するコンテンツを提供したりします。
• シンボルやその他のコンテンツへのリンク (linking-to-symbols-and-other-content.md): リンクを使ってページ間の移動を容易にします。
• コンテンツにコードスニペットを追加する (adding-code-snippets-to-your-content.md): API の使い方を説明し、例を示すコードスニペットを作成して含めます。
• 異なる言語表現で API のドキュメントを作成する ([Documenting API with different language representations/documenting-api-with-different-language-representations.md](Documenting API with different language representations/documenting-api-with-different-language-representations.md)): 複数のソース言語から呼び出せる API のドキュメントを作成します。

構成と書式設定

• ドキュメントのコンテンツを書式設定する (formatting-your-documentation-content.md): テキストやリストに特殊な書式やスタイルを適用して、コンテンツの見栄えを高めます。
• データテーブルを追加する (adding-tables-of-data.md): 情報を行と列に整理します。
• その他の書式設定オプション (other-formatting-options.md): 特別なページ要素を取り入れて、コンテンツの見栄えと構成を改善します。
• コンテンツに画像を追加する (adding-images.md): 画像を追加して、コンテンツの視覚的な魅力を高めます。
• ドキュメントページに構造を追加する (adding-structure-to-your-documentation-pages.md): シンボルをグループやコレクションに整理して、見つけやすくします。
• ドキュメントページの外観をカスタマイズする (customizing-the-appearance-of-your-documentation-pages.md): ドキュメントのウェブページの見た目や雰囲気をカスタマイズします。

配布

• ドキュメントを他の開発者に配布する (distributing-documentation-to-other-developers.md): ウェブサーバーでホストして、ドキュメントを共有します。

ドキュメントの種類

• API ドキュメント ([Reference Syntax/API Reference Syntax/api-reference-syntax.md](Reference Syntax/API Reference Syntax/api-reference-syntax.md)): コードコメントや拡張ファイルから作成したリファレンスドキュメントで API を説明するほか、詳細な記事や概念ガイドを作成します。
• インタラクティブなチュートリアル ([Reference Syntax/Tutorials Syntax/tutorial-syntax.md](Reference Syntax/Tutorials Syntax/tutorial-syntax.md)): 段階的に進められるインタラクティブなコンテンツで、開発者に Swift API を説明します。

共通構文

使用上の注意

• ドキュメントは、入門から高度なトピックへと段階的に構成されています
• 「Introduction」または「Getting Started」セクションから始めてください
• 詳細については、該当するガイドを参照してください

ライセンスと帰属表示

このスキルには、DocC ドキュメント形式から変換されたコンテンツが含まれています。