<value> documentation tag

The <value> tag lets you describe a property and property accessor methods. When you add a property with a code wizard in the Visual Studio integrated development environment, it will add a <summary> tag for the new property. You need to manually add a <value> tag to describe the value that the property represents.

Syntax

/// <value>property-description</value>

Parameters

property-description
A description for the property.

Remarks

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

Example

// xml_value_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_value_tag.dll
using namespace System;
/// Text for class Employee.
public ref class Employee {
private:
   String ^ name;
   /// <value>Name accesses the value of the name data member</value>
public:
   property String ^ Name {
      String ^ get() {
         return name;
      }
      void set(String ^ i) {
         name = i;
      }
   }
};

See also

XML documentation