<see> (C# -Programmierhandbuch)<see> (C# Programming Guide)

SyntaxSyntax

<see cref="member"/>  

ParameterParameters

cref = " member"cref = " member"
Ein Verweis auf einen Member oder ein Feld, das von der aktuellen Kompilierungsumgebung aufgerufen werden kann.A reference to a member or field that is available to be called from the current compilation environment. Der Compiler überprüft, ob das angegebene Codeelement vorhanden ist, und übergibt member an den Elementnamen in der XML-Ausgabe. member muss in doppelte Anführungszeichen („“) gesetzt werden.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 (" ").

HinweiseRemarks

Mit dem <see>-Tag kann ein Link im Text angegeben werden.The <see> tag lets you specify a link from within text. Verwenden Sie <seealso>, um anzugeben, dass Text in einen Abschnitt „Siehe auch“ eingefügt werden soll.Use <seealso> to indicate that text should be placed in a See Also section. Verwenden Sie das cref-Attribut, um interne Links zu Dokumentationsseiten für Codeelemente zu erstellen.Use the cref Attribute to create internal hyperlinks to documentation pages for code elements.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.Compile with /doc to process documentation comments to a file.

Im folgenden Beispiel wird ein <see>-Tag innerhalb eines zusammenfassenden Abschnitts dargestellt.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()
    {
    }
}

Siehe auchSee Also

C#-ProgrammierhandbuchC# Programming Guide
Empfohlene Tags für DokumentationskommentareRecommended Tags for Documentation Comments