1 out of 2 rated this helpful - Rate this topic

<value> (C# Programming Guide)

Visual Studio 2010

Copy

<value>property-description</value>

Parameters

property-description: A description for the property.

Remarks

The <value> tag lets you describe the value that a property represents. 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. You should then manually add a <value> tag to describe the value that the property represents.

Compile with /doc to process documentation comments to a file.

Example

Copy


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

Reference

Concepts

C# Programming Guide

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ

Example not according to common recommendations

According to StyleCop (http://stylecop.codeplex.com/), it should be something like this:

/// <summary>Gets or sets the employee's name.</summary>
/// <value>The employee's name.</value>

History

6/23/2010
Paulo Morgado