Freigeben über

<see> (C#-Programmierhandbuch)

  • Artikel

Aktualisiert: November 2007

<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.

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

Ein Beispiel für das Verwenden von <see> finden Sie unter <summary>.

Beispiel

Im folgenden Beispiel wird veranschaulicht, wie ein cref-Verweis auf einen generischen Typ erstellt wird.

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
// <summary cref="C &lt; T &gt;">

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

Siehe auch

Konzepte

C#-Programmierhandbuch

Referenz

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