Freigeben über


<see> (Visual C++)

Mit dem <see>-Tag kann ein Link im Text angegeben werden.Verwendung <seealso>, Text anzugeben, die Sie in einem Abschnitt Siehe auch angezeigt werden sollen.

<see cref="member"/>

Parameter

  • member
    Ein Verweis auf einen Member oder ein Feld, der bzw. das von der aktuellen Kompilierungsumgebung aufgerufen werden kann.Fügen Sie den Namen in einfache oder doppelte Anführungszeichen eingeschlossen werden.

    Die Compilerprüfungen, ob das angegebene Codeelement member dem Elementnamen in der Ausgabe XML vorhanden und auflöst.Der Compiler gibt eine Warnung aus, wenn nicht member sucht.

Hinweise

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

Siehe <summary> als ein Beispiel für die Verwendung von <see>.

Der Visual C++-Compiler versucht, cref Verweise in einer Durchlauf durch die Dokumentationskommentare aufzulösen.Wenn, die C++-Suchenregeln verwenden, ein Symbol vom Compiler nicht gefunden wird, wird der Verweis markiert, wie nicht aufgelöst.Weitere Informationen finden Sie unter <seealso> (Visual C++).

Beispiel

Das folgende Beispiel veranschaulicht, wie Sie cref Bezug auf einen generischen Typ ausführen können, so, dass, der Compiler den Verweis auflöst.

// 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 &lt; T &gt;"/>

// 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 {};

Siehe auch

Weitere Ressourcen

XML Documentation (Visual C++)