<see> Dokumentationstag
Mit dem <see>-Tag kann ein Link im Text angegeben werden. Hier können <seealso> Sie Text angeben, der in einem Abschnitt "Siehe auch " angezeigt werden soll.
Syntax
/// <see cref="member"/>
Parameter
member
Ein Verweis auf einen Member oder ein Feld, das von der aktuellen Kompilierungsumgebung aufgerufen werden kann. Setzen Sie den Namen in einfache oder doppelte Anführungszeichen.
Der Compiler überprüft, ob das angegebene Codeelement vorhanden ist, und löst member in den Elementnamen in der XML-Ausgabe auf. Der Compiler gibt eine Warnung aus, wenn er nicht gefunden memberwird.
Hinweise
Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.
Ein Beispiel für die Verwendung <see>finden Sie unter <summary>.
Der MSVC-Compiler versucht, Verweise in einem Durchgang durch die Dokumentationskommentare aufzulösen cref . Wenn der Compiler bei Verwendung der C++-Nachschlageregeln kein Symbol findet, wird der Verweis als nicht aufgelöst markiert. Weitere Informationen finden Sie unter <seealso>.
Beispiel
Das folgende Beispiel zeigt, wie Sie auf einen generischen Typ verweisen können cref , damit der Compiler den Verweis auflösen wird.
// xml_see_cref_example.cpp
// compile with: /LD /clr /doc
// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <see cref="C{T}">
/// </see>
ref class A {};
// the following cref shows another way to specify the reference,
// such that, the compiler will resolve the reference
/// <see cref="C < T >"/>
// the following cref shows how to hard-code the reference
/// <see cref="T:C`1">
/// </see>
ref class B {};
/// <see cref="A">
/// </see>
/// <typeparam name="T"></typeparam>
generic<class T>
ref class C {};