Etiqueta de documentación <remarks>
La etiqueta <remarks>
se usa para agregar información sobre un tipo y complementa la información especificada con <summary>
. Esta información se muestra en la ventana Examinador de objetos y en el informe web de comentario de código.
Sintaxis
/// <remarks>description</remarks>
Parámetros
description
Descripción del miembro.
Comentarios
Compile con /doc
para procesar los comentarios de documentación a un archivo.
Ejemplo
// 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 {};