<value> (C#-Programmierhandbuch)

Syntax

<value>property-description</value>  

Parameter

property-description
Eine Beschreibung der Eigenschaft

Hinweise

Mit dem <value>-Tag können Sie den Wert beschreiben, den eine Eigenschaft darstellt. Beachten Sie, dass beim Hinzufügen einer Eigenschaft mithilfe des Code-Assistenten in der Entwicklungsumgebung von Visual Studio .NET der neuen Eigenschaft ein <summary>-Tag hinzugefügt wird. Sie sollten dann manuell ein <value>-Tag hinzufügen, um den Wert zu beschreiben, den die Eigenschaft darstellt.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.

Beispiel

// 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 value of the string field, _name.</value>

    public string Name
    {
        get
        {
            return _name;
        }
        set
        {
            _name = value;
        }
    }
}

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

Siehe auch

C#-Programmierhandbuch
Empfohlene Tags für Dokumentationskommentare