<seealso> Dokumentationstag
Mit dem <seealso>-Tag kann der Text angegeben werden, der im Abschnitt „Siehe auch“ angezeigt werden sollen. Mit <see> kann ein Link im Text angegeben werden.
Syntax
/// <seealso 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.
Informationen zum Erstellen eines cref Verweises auf einen generischen Typ finden Sie unter <see>.
Hinweise
Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.
Unter <summary> finden Sie ein Beispiel für die Verwendung von <seealso>.
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.
Beispiel
Im folgenden Beispiel wird auf ein nicht aufgelöstes Symbol in einem cref. Der XML-Kommentar für das cref An A::Test ist wohlgeformt: <seealso cref="M:A.Test" />. cref Dies B::Test wird <seealso cref="!:B::Test" />jedoch .
// xml_seealso_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_seealso_tag.dll
/// Text for class A.
public ref struct A {
/// <summary><seealso cref="A::Test"/>
/// <seealso cref="B::Test"/>
/// </summary>
void MyMethod(int Int1) {}
/// text
void Test() {}
};
/// Text for class B.
public ref struct B {
void Test() {}
};