コンピュータ・IT 目的モバイル開発プログラミング言語 Swift ツール Swift-DocC

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

Name: Swift-DocCでドキュメントをつくる
Price: 500 JPY
Availability: InStock

発売日: 2022/1/29 想定ページ数: 38ページ全文検索: 対応

★★★★★ ★★★★★ 0件

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
第2章　APIリファレンス

前提知識

1.1　Swift-DocCとは
1.2　Swift-DocCを使う方法
1.3　学ぶための情報源
1.4　サンプルの確認
1.5　実際に手を動かすための準備
- コラム：フレームワークやパッケージ以外でのSwift-DocCの活用
- Tips：Xcodeプロジェクトのビルド時にドキュメントもビルドする設定
1.6　作成したドキュメントの共有
1.7　Webサイトでの公開

2.1　APIリファレンスとは
2.2　リファレンスが生成される流れ
2.3　リファレンス用のコメント
2.4　1行サマリー
2.5　引数と戻り値の説明
2.6　詳細な説明
2.7　より詳細な情報源

3.1　APIリファレンスの改善
3.2　Documentationカタログ
3.3　Documentationカタログの作成
3.4　アーティクル
3.5　ランディングページ
3.6　クラスや構造体のカテゴリ分け
3.7　Extensionファイル
3.8　プロパティやメソッドのカテゴリ分け
3.9　より詳細な情報源

4.1　チュートリアルとは
4.2　チュートリアルの構成
4.3　チュートリアルの構成ファイル
4.4　目次ファイル
- 4.4.1　@Intro ディレクティブ
- 4.4.2　@Chapter ディレクティブ
- 4.4.3　@Resources ディレクティブ
4.5　チュートリアルファイル
- 4.5.1　@Intro ディレクティブ
- 4.5.2　@Section ディレクティブ
- 4.5.3　@ContentAndMedia ディレクティブ
- 4.5.4　@Assessments ディレクティブ
4.6　ステップの記述
- 4.6.1　@Code ディレクティブ
- 4.6.2　プレビュー画像の表示
- 4.6.3　画像を使用したステップ
4.7　より詳細な情報源

WWDCセッションビデオ
Swift.orgブログ

2022年1月22日 Ver.1.0.0
2022年1月26日 Ver.1.0.1
2022年1月29日 Ver.1.0.2
2022年9月10日 Ver.1.1.0

奥付

宇佐見公輔

iOSアプリ開発エンジニア。技術勉強会での登壇、技術記事や技術同人誌の執筆を精力的に行う。特に、学習の敷居が高いと言われがちな領域について、導入部分を工夫することで敷居を下げて学びやすくした内容に定評がある。また、アプリ開発のプログラミングでは、宣言型プログラミングの手法に関心をもち、リアクティブプログラミングを取り入れている。学生時代は数学専攻。現在も数学系イベントでの登壇なども行う。

この著者の書籍一覧

まだレビューが投稿されていません

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

一緒に読まれている本