<value> (C#-Programmierhandbuch)<value> (C# Programming Guide)

SyntaxSyntax

<value>property-description</value>  

ParameterParameters

property-description
Eine Beschreibung der EigenschaftA description for the property.

HinweiseRemarks

Mit dem <value>-Tag können Sie den Wert beschreiben, den eine Eigenschaft darstellt.The <value> tag lets you describe the value that a property represents. 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.Note that when you add a property via code wizard in the Visual Studio .NET development environment, it will add a <summary> tag for the new property. Sie sollten dann manuell ein <value>-Tag hinzufügen, um den Wert zu beschreiben, den die Eigenschaft darstellt.You should then manually add a <value> tag to describe the value that the property represents.

Dokumentationskommentare werden zu einer Datei verarbeitet, indem sie mit /doc kompiliert werden.Compile with /doc to process documentation comments to a file.

BeispielExample

// 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 auchSee Also

C#-ProgrammierhandbuchC# Programming Guide
Empfohlene Tags für DokumentationskommentareRecommended Tags for Documentation Comments