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

構文Syntax

<see cref="member"/>  

パラメーターParameters

cref = "member"cref = " member"
現在のコンパイル環境からの呼び出しに利用できる、メンバーまたはフィールドへの参照。A reference to a member or field that is available to be called from the current compilation environment. コンパイラは、指定されたコード要素が存在するかどうかを確認し、member を出力 XML 内の要素名に渡します。The compiler checks that the given code element exists and passes member to the element name in the output XML. メンバーは二重引用符 (" ") で囲む必要があります。Place member within double quotation marks (" ").

解説Remarks

<see> タグを使用すると、テキスト内でリンクを指定できます。The <see> tag lets you specify a link from within text. テキストが参照セクションに配置されていることを示すには、<seealso> を使用します。Use <seealso> to indicate that text should be placed in a See Also section. コード要素のドキュメント ページへの内部ハイパーリンクを作成するには、cref 属性を使用します。Use the cref Attribute to create internal hyperlinks to documentation pages for code elements.

コンパイル時に -doc を指定して、ドキュメント コメントをファイルに出力します。Compile with -doc to process documentation comments to a file.

次の例では、summary セクション内の <see> タグを示しています。The following example shows a <see> tag within a summary section.

// 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 also