Поделиться через

<value> тег документации

  • Статья

Тег <value> позволяет описать методы доступа к свойству и свойствам. При добавлении свойства с помощью мастера кода в интегрированной среде разработки Visual Studio он добавит <summary> тег для нового свойства. Необходимо вручную добавить <value> тег, чтобы описать значение, которое представляет свойство.

Синтаксис

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

Параметры

property-description
Описание свойства.

Замечания

Скомпилируйте их для /doc обработки примечаний документации к файлу.

Пример

// 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;
      }
   }
};

См. также

XML-документация