<summary> (Visual C++)

La etiqueta <summary> se utiliza para describir un tipo o un miembro de tipo.Utilice <remarks> para suministrar información adicional a una descripción de tipo.

<summary>description</summary>

Parámetros

  • description
    Resumen del objeto.

Comentarios

El texto de la etiqueta de <summary> es la única fuente de información sobre el tipo en IntelliSense, y se muestra en Examinador de objetos y en el informe web de comentarios de código.

Compile con el parámetro /doc para procesar los comentarios de documentación y generar un archivo con ellos.

Ejemplo

// 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() {}
};

Vea también

Otros recursos

Documentación XML (Visual C++)