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

<see cref="member"/>

パラメーター

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

解説

<see> タグを使用すると、テキスト内でリンクを指定できます。テキストが参照セクションに配置されていることを示すには、<seealso> を使用します。コード要素のドキュメント ページへの内部ハイパーリンクを作成するには、cref 属性を使用します。

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

次の例では概要のセクション内の <see> のタグを示します。

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

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

参照

関連項目

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

概念

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

  • Last updated on