Chapter 01無料公開

はじめに

USAMI Kosuke
USAMI Kosuke
2022.01.31に更新
このチャプターの目次

Swift-DocCは、Swiftフレームワークやパッケージのためのドキュメント作成ツールです。Swiftのソースコードからドキュメントを生成したり、Markdownを使ってドキュメントを作成したりできます。

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

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

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

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

前提知識

前提知識として、Swift言語の基本はある程度知っているものとします。また、Xcodeの使いかたもある程度知っているものとします。

開発環境としてMacとXcodeを使います。Swift-DocCはMac以外でも使用可能ですが、本書では扱いません。Xcodeはバージョン13以降が必要です。

脚注
  1. https://github.com/realm/jazzy ↩︎

  2. https://github.com/SwiftDocOrg/swift-doc ↩︎