ファイルにマークアップを追加
マークアップ区切り文字は、.playground または .swift ファイル内の特別なコメントマーカー内に表示されます。
Single line (単一行) のコメントマーカーには、マークアップ区切り文字を含む 1 行のテキストが含まれます。
たとえば、以下のマークアップは、図 3-1 に示すように、プレイグラウンドのレンダリングされた文書内のプレイグラウンドプロジェクトの次のページへのリンクを表示します。
//: [Next Topic](@next)
図 3-1 Single line (単一行) のコメントの例
Block (ブロック) のコメントマーカーは、マークアップ区切り文字を含む 1 行以上のテキストを囲みます。
…
たとえば、以下のマークアップは、図 3-2 に示すように、Swift メソッドのクイックヘルプにパラメータセクションを追加します。
- /**
- - parameters:
- - cubes: The cubes available for allocation
- - people: The people that require cubes
- */
図 3-2 ブロックのコメントの例
プレイグラウンドとシンボルのマークアップでは、異なるコメントマーカーを使用します。詳細については、マークアップ用のコメントマーカー を参照してください。
レンダリングされた内容の順序
マークアップで区切られた内容は、ソースエディタに表示されるのと同じ順序で、レンダリングされたページに表示されます。
プレイグラウンドでの内容の順序
レンダリングされた文書モードのプレイグラウンドのページには、レンダリングされたマークアップが他の内容と共に散在しています。
図 3-3 は、同じプレイグラウンドの 2 つのスクリーンショットを示しています。生のマークアップは左側にあり、レンダリングされた文書は右側にあります。赤いボックスは、各マークアップ区切り文字とその対応するレンダリング出力を示しています。たとえば、ページの各ビューの上部のボックスのページは、第 1 レベルの見出し、番号付きリスト、および画像を含むマークアップが表示されます。次のボックスには、見出し、テキスト行、そして太字の単語を含むテキスト行が表示されます。最後のボックスには、次のプレイラウンドページへのリンクである 1 行のコメントが表示されます。
Swift の内容には、マークアップの内容が散在して表示されます。たとえば、myPageShortTitle の定数の定義は、ページの各ビューの最初のボックスの下にある最初のアイテムです。
図 3-3 レンダリングされたマークアップの順序
クイックヘルプでの内容の順序付け
クイックヘルプは、マークアップをさまざまなセクションにグループ化します。各セクションのレンダリングされた内容は、レンダリングされていないマークアップと同じ順序で表示されます。
たとえば、次のマークアップにより、図 3-4 に示すクイックヘルプが生成されます。
1 /** 2 Another description 3 4 - important: Make sure you read this 5 - returns: a Llama spotter rating between 0 and 1 as a Float 6 - parameter totalLlamas: The number of Llamas spotted on the trip 7 8 More description 9 */
図 3-4 クイックヘルプのセクション
行 2〜4 および行 8 のマークアップは、Description (説明) のセクションを生成します。セクション内のレンダリングされた要素の順序は、マークアップ内の順序と同じです。1 行目からのテキストが説明の上部に表示され、4 行目の重要な呼び出しが次に表示され、そして 8 行目からあのテキストが表示されます。
6 行目は、説明の最終行に使用されるマークアップの前にある場合でも、parameter (パラメータ) セクションに内容を生成します。 同様に、5 行目は、パラメータセクションの後に続く Return セクションを生成します。
マークアップを使用してクイックヘルプを生成する方法の詳細については、クイックヘルプの構文 を参照してください。
トップへ
トップへ
トップへ
トップへ
トップへ