<summary> (Guida per programmatori C#)

Articolo
09/12/2008

Aggiornamento: novembre 2007

<summary>description</summary>

Parametri

description
Riepilogo relativo all'oggetto.

Note

Il tag <summary> deve essere utilizzato per descrivere un tipo o un membro del tipo. Utilizzare <remarks> per aggiungere informazioni supplementari alla descrizione di un tipo.

Il testo del tag <summary> rappresenta l'unica fonte di informazioni sul tipo in IntelliSense e viene visualizzato anche nel Visualizzatore oggetti.

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

Esempio

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

Vedere anche

Concetti

Guida per programmatori C#

Riferimenti

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

Condividi tramite