Etiquetas recomendadas para comentarios de documentación (Guía de ... https://msdn.microsoft.com/es-es/library/5ast78ax(v=vs.100).

aspx

Este artículo se tradujo automáticamente. Para ver el artículo en inglés, active la

casilla Inglés. Además, puede mostrar el texto en inglés en una ventana emergente si Traducción Inglés
mueve el puntero del mouse sobre el texto.

Visual Studio 2010

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

Las etiquetas se procesan sobre construcciones de código, tales como tipos y miembros de tipos.

Nota

Los comentarios de documentación no se pueden aplicar a un espacio de nombres.

El compilador procesará cualquier etiqueta válida en XML. Las siguientes etiquetas proporcionan funcionalidad de uso
general en la documentación de usuario.

<c> <para> <see>*

<code> <param>* <seealso>*

<example> <paramref> <summary>

<exception>* <permission>* <typeparam>*

<include>* <remarks> <typeparamref>

<list> <returns> <value>

(* indica que el compilador comprueba la sintaxis.)

Si desea que aparezcan corchetes angulares en el texto de un comentario de documentación, utilice &lt; y &gt;, como
se muestra en el ejemplo siguiente.

1 de 2 13/02/2017 13:18
Etiquetas recomendadas para comentarios de documentación (Guía de ... https://msdn.microsoft.com/es-es/library/5ast78ax(v=vs.100).aspx

/// <summary cref="C &lt; T &gt;">

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

Adiciones de comunidad

© 2017 Microsoft

2 de 2 13/02/2017 13:18