Compartir a través de

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

  • Artículo

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 basada en el archivo compilador- generado, puede crear una herramienta personalizada, o utilice una herramienta como. Castillo de arena

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

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

Vea también

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#