Marca de documentação <remarks>
A marca <remarks> é usada para adicionar informações sobre um tipo, complementando as informações especificadas com <summary>. Essas informações são exibidas no Pesquisador de Objetos e no relatório Web de comentários sobre código.
Sintaxe
/// <remarks>description</remarks>
Parâmetros
description
Uma descrição do membro.
Comentários
Compile com /doc para processar comentários de documentação em um arquivo.
Exemplo
// 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 {};