<seealso> tag della documentazione

Il <seealso> tag consente di specificare il testo da visualizzare in una sezione Vedere anche. Utilizzare <see> per specificare un collegamento dall'interno del testo.

Sintassi

/// <seealso cref="member"/>

Parametri

member
Riferimento a un membro o a un campo disponibile per essere chiamato dall'ambiente di compilazione corrente. Racchiudere il nome tra virgolette singole o doppie.

Il compilatore verifica l'esistenza dell'elemento di codice specificato e risolve member nel nome dell'elemento nel file XML di output. Il compilatore genera un avviso se non trova member.

Per informazioni su come creare un cref riferimento a un tipo generico, vedere <see>.

Osservazioni:

Compilare con /doc per elaborare i commenti della documentazione in un file.

Vedere <summary> per un esempio di uso <seealso>di .

Il compilatore MSVC tenta di risolvere cref i riferimenti in un solo passaggio tra i commenti della documentazione. Se il compilatore non trova un simbolo quando si usano le regole di ricerca C++, contrassegna il riferimento come non risolto.

Esempio

Nell'esempio seguente viene fatto riferimento a un simbolo non risolto in un oggetto cref. Il commento XML per l'oggetto cref a A::Test è ben formato: <seealso cref="M:A.Test" />. Tuttavia, l'oggetto cref a B::Test diventa <seealso cref="!:B::Test" />.

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

Vedi anche

Documentazione XML