マークアップの機能
マークアップは、単純な文字をベースとした区切り文字を使用して、プレイグラウンドおよび Swift シンボルのクイックヘルプで書式設定されたテキストをマークします。
さまざまな区切り文字には、以下の機能が含まれます。
- 見出しの作成などのテキスト行の書式設定
- 箇条書きリストの作成など、複数行のテキストの書式設定
- 文字列に強調を加えるなど、文字列の全長を書式設定する
- Web をベースにした内容へのリンクの挿入
- 画像やビデオなどのアセットを挿入する
- プレイグラウンドの例やクイックヘルプのパラメータなどの呼び出しを挿入します。
- マークアップの区切り文字を含む特殊文字のエスケープ
一部の区切り文字は、レンダリングされたプレイグラウンド文書とクイックヘルプの両方で使用されます。他の区切り文字は、プレイグラウンドまたはクイックヘルプで使用されます。各区切り文字の文書には、使用できる場所に関する情報が含まれています。さらに、表 2-1 に、簡単な説明を含むすべての区切り文字のアルファベット順の概要を示します。
マークアップの追加については、マークアップの使用 を参照してください。
表 2-1 マークアップの区切り文字
| 区切り文字名 | 説明 | プレイグラウンド | クイックヘルプ |
| Attention(注意) | Attention の呼び出しを追加します。 | ✓ | |
| Author(著者) | Author の呼び出しを追加します。 | ✓ | |
| Authors(著者) | 複数の著者の Authors の呼び出しを追加します。 | ✓ | |
| Block Comment(ブロックコメント) | マークアップのブロックを開閉するためのコメントマーカー。 | ✓ | ✓ |
| Bug(バグ) | Bug の呼び出しを追加します。 | ✓ | |
| Bulleted Lists(箇条書きリスト) | 箇条書きリストを追加します。 | ✓ | ✓ |
| Code Block(コードブロック) | テキストの行をコードのブロックとしてレンダリングします。 | ✓ | ✓ |
| Code Voice(コードボイス) | コードの表示に使用されるフォントでテキストの全体をレンダリングします。 | ✓ | ✓ |
| Complexity(複雑さ) | Complexity の呼び出しを追加します。 | ✓ | |
| Copyright(著作権) | Copyright の呼び出しを追加します。 | ✓ | |
| Custom Callout(カスタムのコールアウト) | カスタムテキストで呼び出しを追加します。 | ✓ | |
| Date(日付) | Date の呼び出しを追加します。 | ✓ | |
| Emphasis (Italics)(強調、イタリック) | テキストの範囲をを強調してレンダリングします。 | ✓ | ✓ |
| Escapes(エスケープ) | 次のキャラクターの特別な動作を無効にします。 | ✓ | ✓ |
| Example(例) | Example の呼び出しを追加します。 | ✓ | |
| Experiment(実験) | Experiment の呼び出しを追加します。 | ✓ | ✓ |
| Headings(見出し) | 見出しとして行をレンダリングします。 | ✓ | ✓ |
| Horizontal Rules(横罫線) | 横罫線の追加。 | ✓ | ✓ |
| Images(画像) | Web またはプレイグラウンドのプロジェクトから画像を表示します。 | ✓ | ✓ |
| Important(重要) | Important の呼び出しを追加します。 | ✓ | ✓ |
| Invariant(不変な) | Invariant の呼び出しを追加します。 | ✓ | |
| Link Reference(リンク参照) | 複数の場所で使用されている URL に、名前の付いた参照を追加します。 | ✓ | ✓ |
| Links(リンク) | テキストをベースにしたリソースにリンクを追加します。 | ✓ | ✓ |
| Named Page(名前の付いたページ) | 名前の付いたプレイグラウンドのページへのリンクを追加します。 | ✓ | |
| Next Page(次のページ) | プロジェクト内の次のプレイグラウンドのページへのリンクを追加します。 | ✓ | |
| Note(注意) | Note の呼び出しを追加します。 | ✓ | ✓ |
| Numbered Lists(番号の付いたリスト) | 番号の付いたリストを追加します。 | ✓ | ✓ |
| Parameter(パラメータ) | クイックヘルプのパラメータの部分に、parameter を追加します。 | ✓ | |
| Parameters(パラメータ) | クイックヘルプのパラメータの部分に、複数の parameter を追加します。 | ✓ | |
| Postcondition(事後条件) | Postcondition の呼び出しを追加します。 | ✓ | |
| Precondition(前提条件) | Precondition の呼び出しを追加します。 | ✓ | |
| Previous Page(前のページ) | プレイグラウンド内で、前のページへのリンクを追加します。 | ✓ | |
| Remark(注目) | Remark の呼び出しを追加します。 | ✓ | |
| Returns(応答) | クイックヘルプに、Returns セクションを追加します。 | ✓ | |
| Requires(要件) | Requires の呼び出しを追加します。 | ✓ | |
| See Also(以下も見よ) | See Also の呼び出しを追加します。 | ✓ | |
| Since(以来) | Since の呼び出しを追加します。 | ✓ | |
| Single Line Comment(一行のコメント) | マークアップの一行に使用されるコメントマーカー。 | ✓ | ✓ |
| Strong (Bold)(強調、太字) | テキストの全体を太字でレンダリングします。 | ✓ | ✓ |
| Throws(スロー) | クイックヘルプに、Throws セクションを追加します。 | ✓ | |
| To Do(すべき) | To Do の呼び出しを追加します。 | ✓ | |
| Version(バージョン) | Version の呼び出しを追加します。 | ✓ | |
| Videos(ビデオ) | 生のビデオプレーヤーを追加します。 | ✓ | |
| Warning(警告) | Warning の呼び出しを追加します。 | ✓ |
トップへ
トップへ
トップへ
トップへ
トップへ