<see> (C#-Programmierhandbuch)

Artikel
02/26/2013

<see cref="member"/>

Parameter

cref = "member"
Ein Verweis auf einen Member oder ein Feld, der bzw. das von der aktuellen Kompilierungsumgebung aufgerufen werden kann.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 (" ") eingeschlossen werden.

Hinweise

Mit dem <see>-Tag kann ein Link im Text angegeben werden.Verwenden Sie <seealso>, um anzugeben, dass Text in einen Siehe auch-Abschnitt eingefügt werden soll.Verwenden Sie das cref-Attribut, um interne Links zu Dokumentationsseiten für Codeelemente zu erstellen.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit "/doc" kompiliert werden.

Im folgenden Beispiel wird ein <see> Tag innerhalb eines zusammenfassenden Abschnitts dargestellt.

// 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()
    {
    }
}

Ein Beispiel für die Verwendung von <see> finden Sie unter <summary>.

Siehe auch

Referenz

Empfohlene Tags für Dokumentationskommentare (C#-Programmierhandbuch)

Konzepte

C#-Programmierhandbuch

Freigeben über