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

<summary>

  • Статья

Тег <summary> следует использовать для описания типа или элемента типа. Чтобы добавить дополнительную информацию в описание типа, используйте <remarks>.

Синтаксис

/// <summary>description</summary>

Параметры

description
Сводка объекта.

Замечания

Текст <summary> тега является единственным источником сведений о типе в IntelliSense, а также отображается в браузере объектов и в веб-отчете о комментариях кода.

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

Пример

// xml_summary_tag.cpp
// compile with: /LD /clr /doc
// post-build command: xdcmake xml_summary_tag.dll

/// Text for class MyClass.
public ref class MyClass {
public:
   /// <summary>MyMethod is a method in the MyClass class.
   /// <para>Here's how you could make a second paragraph in a description. <see cref="System::Console::WriteLine"/> for information about output statements.</para>
   /// <seealso cref="MyClass::MyMethod2"/>
   /// </summary>
   void MyMethod(int Int1) {}

   /// text
   void MyMethod2() {}
};

См. также

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