<summary>
La etiqueta <summary>
debe usarse para describir un tipo o un miembro de tipo. Use <remarks>
para agregar información adicional a una descripción de tipo.
Sintaxis
/// <summary>description</summary>
Parámetros
description
Resumen del objeto.
Comentarios
El texto de la etiqueta <summary>
es la única fuente de información sobre el tipo en IntelliSense y también se muestra en la ventana Examinador de objetos y el informe web de comentario de código.
Compile con /doc
para procesar los comentarios de documentación a un archivo.
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() {}
};