<see> tag della documentazione

Con il tag <see> è possibile specificare un collegamento nel testo. Usare <seealso> per indicare il testo che si potrebbe voler visualizzare in una sezione Vedere anche .

Sintassi

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

Osservazioni:

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

Per un esempio di uso <see>di , vedere <summary>.

Il compilatore MSVC tenterà di risolvere cref i riferimenti in un passaggio attraverso i commenti della documentazione. Se il compilatore non trova un simbolo quando usa le regole di ricerca C++, contrassegna il riferimento come non risolto. Per ulteriori informazioni, vedere <seealso>.

Esempio

Nell'esempio seguente viene illustrato come fare cref riferimento a un tipo generico in modo che il compilatore risolva il riferimento.

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

Vedi anche

Documentazione XML