ドキュメント タグの区切り記号 (C# プログラミング ガイド)
更新 : 2007 年 11 月
XML ドキュメント コメントでは区切り記号を使用して、ドキュメント コメントの開始位置と終了位置をコンパイラに示す必要があります。XML ドキュメント タグでは、次の種類の区切り記号を使用できます。
///
ドキュメント例で使用されています。この区切り記号は、Visual C# プロジェクト テンプレートで使用されます。.gif "メモ")
メモ :Visual Studio IDE には、スマート コメント編集と呼ばれる機能があります。コード エディタで /// 区切り記号を入力すると、<summary> タグと </summary> タグが自動的に挿入され、これらのタグの内側にカーソルが移動します。この機能には、プロジェクト プロパティ ページの [書式設定] ([オプション] ダイアログ ボックス - [テキスト エディタ] - [C#])からアクセスします。
/** */
複数行の区切り記号
/** と */ を使用する場合は、書式に関する次の規則が適用されます。
/** 区切り記号がある行では、行の残りの部分が空白の場合、その行はコメントとして扱われません。最初の文字が空白の場合、その空白文字は無視され、行の残りの部分が処理されます。それ以外の場合は、/** 区切り記号の後にある行のテキスト全体が、コメントの一部として扱われます。
*/ 区切り記号がある行では、*/ 区切り記号までの部分がすべて空白の場合、その行が無視されます。それ以外の場合は、以下の箇条書きで説明するパターン一致規則に従って、その行の */ 区切り記号までのテキストがコメントの一部として扱われます。
/** 区切り記号で始まる行が検出されると、コンパイラはその次の行から、空白 (省略可能) とアスタリスク (*) と、それに続く空白 (省略可能) から成る共通パターンが各行の先頭にあるかどうかを調べます。共通の文字セットが各行の先頭で見つかった場合、/** 区切り記号から */ 区切り記号がある行までのすべての行について (*/ 区切り記号のある行も含まれる可能性があります) 、コンパイラはそのパターンを無視します。
次にいくつかの例を示します。
次の例では、<summary> で始まる行だけがコメントの一部として扱われます。次の 2 とおりの形式のタグは、どちらも同じコメントを生成します。
/**
<summary>text</summary>
*/
/** <summary>text</summary> */
コンパイラは、2 行目と 3 行目の先頭にパターン " * " を適用して無視します。
/**
* <summary>
* text </summary>*/
このコメントでは、2 行目にアスタリスクがないため、パターンが見つかりません。このため、2 行目のすべてのテキストと 3 行目の */ までのすべてのテキストが、コメントの一部として扱われます。
/**
* <summary>
text </summary>*/
このコメントでは、2 つの原因でパターンが見つかりません。第 1 に、各行の先頭で、アスタリスクの前の空白の数が一致していません。第 2 に、5 行目がタブで始まっています。空白とタブは一致しません。このため、2 行目から */ までのすべてのテキストが、コメントの一部として扱われます。
/**
* <summary>
* text
* text2
* </summary>
*/
参照
処理手順
概念
参照
XML ドキュメント コメント (C# プログラミング ガイド)