Etiquetas recomendadas para comentarios de documentación (Guía de programación de C#)Recommended Tags for Documentation Comments (C# Programming Guide)

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.The C# compiler processes documentation comments in your code and formats them as XML in a file whose name you specify in the /doc command-line option. 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.To create the final documentation based on the compiler-generated file, you can create a custom tool, or use a tool such as Sandcastle.

Las etiquetas se procesan en construcciones de código como tipos y miembros de tipo.Tags are processed on code constructs such as types and type members.

Nota

Los comentarios de documentación no pueden aplicarse en un espacio de nombres.Documentation comments cannot be applied to a namespace.

El compilador procesará cualquier etiqueta que sea un XML válido.The compiler will process any tag that is valid XML. Las siguientes etiquetas proporcionan funciones de uso general en la documentación de usuario.The following tags provide generally used functionality in user documentation.

EtiquetasTags

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

(* denota que el compilador comprueba la sintaxis).(* denotes that the compiler verifies syntax.)

Si quiere que aparezcan corchetes angulares en el texto de un comentario de documentación, use < y >, como se muestra en el ejemplo siguiente.If you want angle brackets to appear in the text of a documentation comment, use < and >, as shown in the following example.

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

Vea tambiénSee Also

Guía de programación de C#C# Programming Guide
/doc (opciones del compilador de C#)/doc (C# Compiler Options)
Comentarios de documentación XMLXML Documentation Comments