Visual C++ ドキュメント タグの区切り記号
ドキュメント タグを使用すると、ドキュメント コメントの開始位置と終了位置をコンパイラに示す区切り記号を使用します。
XML ドキュメント タグでは、次の種類の区切り記号を使用できます。
///
これは、ドキュメント例では、Visual C++ プロジェクト テンプレートで使用されています。/** */
これらは、複数行の区切り記号です。
/** */ */の区切り記号を使用すると、形式の規則があります:
/**の区切り記号がある行で行の残りが空白の場合は、その行がコメントとして扱われません。最初の文字が空白の場合は、その空白文字は無視され、行の残りの部分が処理されます。それ以外の場合は、/** 区切り記号の後にある行のテキスト全体が、コメントの一部として扱われます。
*/の区切り記号がある行では空白を無視 */ 行の区切り記号までの。それ以外の場合は、以下の箇条書きで説明するパターン一致規則に従って、その行の */ 区切り記号までのテキストがコメントの一部として扱われます。
の場合 /** の区切り記号で始まる 1 は、省略可能の空白とアスタリスク (*) で構成される空白。省略可能に続く各行の先頭に、コンパイラ、共通のパターンの後に来る行。コンパイラは各行の先頭で共通の一連の文字を検索、*/ の区切り記号がある行が /** の区切り記号の後にすべての行のそのパターンは、まであっても無視されます。
次にいくつかの例を示します。
次の例では、<summary> で始まる行だけがコメントの一部として扱われます。次の 2 種類のタグのファイル形式は、同じコメントを生成します:
/** <summary>text</summary> */ /** <summary>text</summary> */コンパイラは、2 行目と 3 行の先頭に無視するためにパターン「*」追加します。
/** * <summary> * text </summary>*/コンパイラは 2 番目の行にアスタリスクがないため、このコメントのパターンを検索します。したがって、*/までの先頭に 2 番目と 3 番目のすべてのテキストは、コメントの一部として扱われます。
/** * <summary> text </summary>*/コンパイラは、このコメントのパターンの 2 種類の理由で検索します。最初に、アスタリスクの前に空白の一貫した番号で始まる行はありません。第 2 に、5 行目がタブで始まっています。空白とタブは一致しません。したがって、*/ までの 2 番目の行からのすべてのテキストは、コメントの一部として扱われます。
/** * <summary> * text * text2 * </summary> */