<see> (C# Programming Guide)


Updated: July 20, 2015

For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.

<see cref="member"/>  


cref = " member"
A reference to a member or field that is available to be called from the current compilation environment. 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 (" ").

The <see> tag lets you specify a link from within text. Use <seealso> to indicate that text should be placed in a See Also section. Use the cref Attribute to create internal hyperlinks to documentation pages for code elements.

Compile with /doc to process documentation comments to a file.

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()

C# Programming Guide
Recommended Tags for Documentation Comments