Condividi tramite


<see> (Guida per programmatori C#)

Aggiornamento: novembre 2007

<see cref="member"/>

Parametri

  • cref = "member"
    Riferimento a un membro o a un campo disponibile per essere chiamato dall'ambiente di compilazione corrente. Il compilatore verifica l'esistenza dell'elemento di codice specificato e passa member al nome di elemento nel file XML di output.Racchiudere member tra virgolette doppie (" ").

Note

Il tag <see> consente di specificare un collegamento nel testo. Utilizzare <seealso> per indicare che deve essere inserito del testo in una sezione Vedere anche.

Eseguire la compilazione con /doc per elaborare in un file i commenti per la creazione della documentazione.

Per un esempio sull'utilizzo di <see>, vedere <summary>.

Esempio

Nell'esempio riportato di seguito viene illustrato come effettuare un riferimento cref a un tipo generico.

// compile with: /doc:DocFileName.xml 

// the following cref shows how to specify the reference, such that,
// the compiler will resolve the reference
/// <summary cref="C{T}">
/// </summary>
class A { }

// the following cref shows another way to specify the reference, 
// such that, the compiler will resolve the reference
// <summary cref="C &lt; T &gt;">

// the following cref shows how to hard-code the reference
/// <summary cref="T:C`1">
/// </summary>
class B { }

/// <summary cref="A">
/// </summary>
/// <typeparam name="T"></typeparam>
class C<T> { }

Vedere anche

Concetti

Guida per programmatori C#

Riferimenti

Tag consigliati per i commenti relativi alla documentazione (Guida per programmatori C#)