次の方法で共有


<see> (Visual C++)

<see> タグを使用すると、テキスト内でリンクを指定できます。示すテキストに <seealso> を使用します。バッチ処理することを確認またはで表示する場合があります。

<see cref="member"/>

パラメーター

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

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

解説

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

<see>使用例については <summary> を参照してください。

Visual C++ コンパイラでは、ドキュメント コメントで 1 回のパスの cref 参照の解決を試みます。したがって、C++ のルックアップ規則を使用して、シンボルがコンパイラによって参照がある未解決です。詳細については、「<seealso> (Visual C++)」を参照してください。

使用例

次の例では、コンパイラは参照の解決は、ジェネリック型への cref 参照のできるかこのようなに示します。

// xml_see_cref_example.cpp
// compile with: /LD /clr /doc
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <see cref="C{T}">
/// </see>
ref class A {};

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
/// <see cref="C &lt; T &gt;"/>

// the following cref shows how to hard-code the reference
/// <see cref="T:C`1">
/// </see>
ref class B {};
 
/// <see cref="A">
/// </see>
/// <typeparam name="T"></typeparam>
generic<class T>
ref class C {};

参照

その他の技術情報

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