次の方法で共有


<see> (C# プログラミング ガイド)

更新 : 2007 年 11 月

<see cref="member"/>

パラメータ

  • cref = "member"
    現在のコンパイル環境からの呼び出しに利用できる、メンバまたはフィールドへの参照。コンパイラは、指定されたコード要素が存在するかどうかを確認し、member を出力 XML 内の要素名に渡します。member は、二重引用符 (" ") で囲みます。

解説

<see> タグを使用すると、テキスト内でリンクを指定できます。テキストが参照セクションに配置されていることを示すには、<seealso> を使用します。

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

<see> タグの使用例については、「<summary>」を参照してください。

使用例

ジェネリック型への cref 参照を作成する方法を次の例に示します。

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

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

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

参照

概念

C# プログラミング ガイド

参照

ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)