Compartilhar via


<summary>

A marca <summary> deve ser usada para descrever um tipo ou um membro de tipo. Use <remarks> para adicionar mais informações a uma descrição de tipo.

Sintaxe

/// <summary>description</summary>

Parâmetros

description
Um resumo do objeto.

Comentários

O texto da marcação <summary> é a única fonte de informações sobre o tipo no IntelliSense e também é exibido no Pesquisador de Objetos e no relatório Web de comentários sobre código.

Compile com /doc para processar comentários de documentação em 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() {}
};

Confira também

Documentação XML