Share via

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

  • Artículo

Actualización: noviembre 2007

El compilador de C# procesa los comentarios de documentación del código y genera con ellos un archivo XML. El procesamiento del archivo XML para crear documentación es un detalle que se debe implementar localmente.

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.

Etiquetas

<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 en el texto de un comentario de documentación aparezcan corchetes angulares, utilice &lt; y &gt;. Por ejemplo, &lt;texto entre corchetes angulares&gt;.

Vea también

Tareas

Ejemplo XML Documentation

Conceptos

Guía de programación de C#

Referencia

/doc (Procesar comentarios de documentación) (Opciones del compilador de C#)

Comentarios de documentación XML (Guía de programación de C#)