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


<remarks> (Visual C++)

Тег <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 (Visual C++)