次の方法で共有


<seealso> (Visual C++)

<seealso> タグを使用すると、「参照」のセクションに示すテキストを指定できます。テキスト内でリンクを指定するには、<see> タグを使用します。

<seealso cref="member"/>

パラメーター

  • member
    現在のコンパイル環境からの呼び出しに利用できる、メンバーまたはフィールドへの参照。単一引用符で囲みます。

    コンパイラは、指定されたコード要素が出力 XML 内の要素名に渡します。は、member を解決することを確認します。コンパイラは memberを検索警告が発行されます。

    ジェネリック型への cref 参照の作成方法については、「<see> (Visual C++)」を参照してください。

解説

コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。

<seealso>使用例については <summary> (Visual C++) を参照してください。

Visual C++ コンパイラでは、ドキュメント コメントで 1 回のパスの cref 参照の解決を試みます。したがって、C++ のルックアップ規則を使用して、シンボルがコンパイラによって参照がある未解決です。

使用例

次の例では、未解決のシンボルは cref で参照されます。B::Test への cref の XML コメントは A::Test への参照が有効な <seealso cref="M:A.Test" />であり、<seealso cref="!:B::Test" />です。

// xml_seealso_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_seealso_tag.dll

/// Text for class A.
public ref struct A {
   /// <summary><seealso cref="A::Test"/>
   /// <seealso cref="B::Test"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void Test() {}
};

/// Text for class B.
public ref struct B {
   void Test() {}
};

参照

その他の技術情報

XML に関するドキュメント (Visual C++)