Marca de documentação <value>
A marcação <value>
permite descrever uma propriedade e os métodos do acessador da propriedade. Quando você adicionar uma propriedade com um assistente de código no ambiente de desenvolvimento integrado do Visual Studio, ele adicionará uma marca <summary>
à nova propriedade. Você precisa adicionar manualmente uma marca <value>
para descrever o valor que a propriedade representa.
Sintaxe
/// <value>property-description</value>
Parâmetros
property-description
Uma descrição da propriedade.
Comentários
Compile com /doc
para processar comentários de documentação em um arquivo.
Exemplo
// 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;
}
}
};