カテゴリ一覧 著者一覧
Swift-DocCでドキュメントをつくる
0件
500円(税込)
獲得ポイント: 5pt
通常:
5pt

Swift-DocCでドキュメントをつくる

発売日: 2022年1月29日
想定ページ数: 38ページ
ダウンロード: PDF EPUB
Swift-DocCは、Swiftフレームワークやパッケージのためのドキュメント作成ツールです。Swiftのソースコードからドキュメントを生成したり、Markdownを使ってドキュメントを作成したりできます。

Swiftのソースコードからドキュメントを生成するツールは、これまでにも、Jazzyやswift-docといったサードパーティ製のツールが存在していました。

これに対して、Swift-DocCはSwift.orgから公式リリースされたツールとなります。Swift-DocCは2021年6月にWWDC21で発表され、Xcode 13に同梱する形でリリースされました。その後、2021年10月にオープンソースソフトウェアになりました。

Swift-DocCはXcodeとの連携が最初から組み込まれている点が強みです。他にも、単なるAPIリファレンスだけでなく、技術記事風の文書を作ったり、チュートリアルを作ったりできるのも面白い特徴です。

本書では、このSwift-DocCの使い方を、初めて触れる方にも分かるよう丁寧に解説します。本書がSwift-DocCの普及に少しでも貢献できればと考えています。

目次

はじめに
前提知識
第1章 Swift-DocC
1.1 Swift-DocCとは
1.2 Swift-DocCを使う方法
1.3 学ぶための情報源
1.4 サンプルの確認
1.5 実際に手を動かすための準備
  • コラム:フレームワークやパッケージ以外でのSwift-DocCの活用
  • Tips:Xcodeプロジェクトのビルド時にドキュメントもビルドする設定
1.6 作成したドキュメントの共有
1.7 Webサイトでの公開
第2章 APIリファレンス
2.1 APIリファレンスとは
2.2 リファレンスが生成される流れ
2.3 リファレンス用のコメント
2.4 1行サマリー
2.5 引数と戻り値の説明
2.6 詳細な説明
2.7 より詳細な情報源
第3章 APIリファレンスの拡張
3.1 APIリファレンスの改善
3.2 Documentationカタログ
3.3 Documentationカタログの作成
3.4 アーティクル
3.5 ランディングページ
3.6 クラスや構造体のカテゴリ分け
3.7 Extensionファイル
3.8 プロパティやメソッドのカテゴリ分け
3.9 より詳細な情報源
第4章 チュートリアル
4.1 チュートリアルとは
4.2 チュートリアルの構成ファイル
4.3 目次ファイルとチュートリアルファイルの作成
4.4 主なディレクティブ
  • 4.4.1 @TutorialReference
  • 4.4.2 @Image
  • 4.4.3 @Code
4.5 より詳細な情報源
おわりに
WWDCセッションビデオ
Swift.orgブログ
更新履歴
2022年1月22日 Ver.1.0.0
2022年1月26日 Ver.1.0.1
2022年1月29日 Ver.1.0.2
奥付

ユーザーレビュー

レビューがありません
書籍をシェアする