<summary> (Visual C++)
A marca de <summary> deve ser usada para descrever um tipo ou membro de tipo.Use <remarks> para adicionar informações suplementares a uma descrição de tipo.
<summary>description</summary>
Parâmetros
- description
Um resumo do objeto.
Comentários
O texto para a marca de <summary> é a única ofnte de informações sobre o tipo IntelliSense, e também é exibido em Pesquisador de objetos e no relatório da Web de comentário de código.
Compile com /doc para processar comentários de documentação para um arquivo.
Exemplo
// 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() {}
};