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


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

Тег <remarks> позволяет добавить сведения о типе, дополняющие информацию, указанную с помощью тега <summary>. Эта информация отображается в обозревателе объектов и в веб-отчете комментариев кода.

Синтаксис

/// <remarks>description</remarks>

Параметры

description
Описание элемента.

Замечания

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

Пример

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

using namespace System;

/// <summary>
/// You may have some primary information about this class.
/// </summary>
/// <remarks>
/// You may have some additional information about this class.
/// </remarks>
public ref class MyClass {};

См. также

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