<value> (Guida per programmatori C#)

<value>property-description</value>

Parametri

  • property-description
    Descrizione della proprietà.

Note

Il tag <value> consente di descrivere il valore rappresentato da una proprietà. Tenere presente che l'aggiunta di una proprietà mediante la procedura guidata per la creazione di codice nell'ambiente di sviluppo di Visual Studio .NET, implica l'aggiunta di un tag <summary> alla nuova proprietà. È quindi necessario aggiungere manualmente un tag <value> per descrivere il valore rappresentato dalla proprietà.

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 Employee
public class Employee
{
    private string _name;

    /// <summary>The Name property represents the employee's name.</summary>
    /// <value>The Name property gets/sets the _name data member.</value>
    public string Name
    {
        get
        {
            return _name;
        }
        set
        {
            _name = value;
        }
    }
}

/// text for class MainClass
public class MainClass
{
    /// text for Main
    static void Main()
    {
    }
}

Vedere anche

Riferimenti

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

Concetti

Guida per programmatori C#