Etiqueta de documentación <value>
La etiqueta <value>
le permite describir una propiedad y los métodos de acceso a la propiedad. Tenga en cuenta que cuando agrega una propiedad mediante un asistente de código en el entorno de desarrollo integrado de Visual Studio, agregará una etiqueta <summary>
a la propiedad nueva. Debe agregar manualmente una etiqueta <value>
para describir el valor que la propiedad representa.
Sintaxis
/// <value>property-description</value>
Parámetros
property-description
Una descripción de la propiedad.
Comentarios
Compile con /doc
para procesar los comentarios de documentación a un archivo.
Ejemplo
// 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;
}
}
};