Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)

El compilador de C# procesa los comentarios de documentación de su código y les aplica formato como XML en un archivo cuyo nombre especifica en la opción de línea de comandos /doc. Para crear la documentación final basada en el archivo generado por el compilador, puede crear una herramienta personalizada o usar una herramienta como Sandcastle.

Las etiquetas se procesan en construcciones de código como tipos y miembros de tipo.

Nota

Los comentarios de documentación no pueden aplicarse en un espacio de nombres.

El compilador procesará cualquier etiqueta que sea un XML válido. Las siguientes etiquetas proporcionan funciones de uso general en la documentación de usuario.

Etiquetas

<c> <para> <see>*
<code> <param>* <seealso>*
<example> <paramref> <summary>
<exception>* <permission>* <typeparam>*
<include>* <remarks> <typeparamref>
<list> <returns> <value>

(* denota que el compilador comprueba la sintaxis).

Si quiere que aparezcan corchetes angulares en el texto de un comentario de documentación, use < y >, como se muestra en el ejemplo siguiente.

/// <summary cref="C < T >">  
/// </summary>  

Vea también

Guía de programación de C#
/doc (Opciones del compilador de C#)
Comentarios de documentación XML