<see> (Guida per programmatori C#)

Articolo
03/05/2013

<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.Utilizzare l'attributo cref per creare collegamenti ipertestuali interni alle pagine della documentazione per gli elementi di codice.

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

L'esempio seguente mostra un tag di <see> all'interno di una sezione del riepilogo.

// compile with: /doc:DocFileName.xml 

/// text for class TestClass
public class TestClass
{
    /// <summary>DoWork is a method in the TestClass class.
    /// <para>Here's how you could make a second paragraph in a description. <see cref="System.Console.WriteLine(System.String)"/> for information about output statements.</para>
    /// <seealso cref="TestClass.Main"/>
    /// </summary>
    public static void DoWork(int Int1)
    {
    }

    /// text for Main
    static void Main()
    {
    }
}

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

Vedere anche

Riferimenti

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

Concetti

Guida per programmatori C#

Condividi tramite