ブロックのコメント
これらの特別な開始および終了コメントマーカーを使用して、マークアップのブロックを追加します。
以下のもので動作します:
✓プレイグラウンド
✓シンボルの文書
プレイグラウンドの文法
コメントを開始するには、スラッシュ (/) の後にアスタリスク (*) 、コロン (:) を続けて使用します。コメントを終わるには、アスタリスクとそれに続くスラッシュを使用します。
/*:
line of text with optional markup
…
line of text with optional markup
*/
コメントの開始と終了の間の行には、テキスト、テキストおよびマークアップを含めることができ、何も含めない事もできます。行数に制限はありません。
コメント開始の同じ行のテキストは無視されます。
例
以下のマークアップは、2014 年のコーヒー生産者トップ 3 の番号付きリストを示しています。
1 /*: 2 1. Brazil 3 2. Vietnam 4 3. Colombia 5 */
クイックヘルプの文法
コメントの開始には、スラッシュ (/) に続けて 2 つのアスタリスク (*) を使用します。コメントを終わるには、アスタリスクとそれに続くスラッシュを使用します。
/**
line of text with optional markup
…
*/
開始の区切り文字と終わりの区切り文字の間の行には、テキスト、テキストおよびマークアップを含めることができ、何も含めない事もできます。行数に制限はありません。
コメントの開始行には、区切り文字の下の行の内容と連結されるテキストを含めることができます。これは、行が連結される唯一のケースです。
例
以下のマークアップは、cube と people のパラメータを文書化します。
1 /** 2 - parameters: 3 - cubes: The cubes available for allocation 4 - people: The people that require cubes 5 */
トップへ
トップへ
トップへ
トップへ
トップへ