チャレンジ: 素晴らしいドキュメントの作成
2021年6月10日
このチャレンジでは、ご自身のフレームワークまたはパッケージ（あるいは好みのオープンソース・プロジェクト）のドキュメントを作成していただきます。Xcode 13を使用して、Swiftフレームワークでヘッダコメントからドキュメントを作成し、ドキュメントカタログを追加してコンテンツを整理します。
チャレンジを開始
Xcodeでご自身のプロジェクトを開き、Swift DocCのmarkdown構文を使用してソースにドキュメントコメントを追加します。あなたがソースコードに記述したコメントは、DocCが生成するドキュメントページのコンテンツとして使用されます。少なくとも、基本のドキュメントコメントをフレームワークのパブリックシンボルに追加してください。これらコメントは、1文から成る要約または概要としてDocCで使用されます。次に例を示します。
/// A model representing a sloth.
///
/// Sloths are mammals noted for their slowness of movement. They spend most of their
/// lives hanging upside down in trees.
public struct Sloth {
/// The species of the sloth.
public var species: Speciesドキュメントの作成が終了したら、“Product”＞“Build Documentation”を選択して、クイックヘルプおよび“デベロッパドキュメント”ウインドウ用のソースドキュメントを作成します。
ドキュメントの記述または作成にヘルプが必要ですか? Developer Tools Digital Loungeをご覧ください。#devtools-study-hallチャンネルのDeveloper Tools Study Hallでは、木曜日の午後1時から5時（太平洋夏時間）まで、進捗状況の共有、プロジェクトに関する質問、他のユーザとの共同作業などを行えます。また、Developer Forumでは“WWDC21-Challenges”タグ、ソーシャルメディアではハッシュタグ#WWDC21Challengesを使用して、ご自身の進捗状況を共有することができます。
Visit the Apple Developer Forums