Compartir a través de


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

En Visual C# puede crear documentación para el código si incluye etiquetas XML en campos de comentario especiales del código fuente, directamente antes del bloque de código al que hacen referencia.Por ejemplo:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

Cuando compila con la opción /doc, el compilador busca todas las etiquetas XML del código fuente y crea un archivo de documentación XML.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.

[!NOTA]

Los comentarios de documentación XML no son metadatos; no se incluyen en el ensamblado compilado y, por tanto, no se puede obtener acceso a ellos mediante la reflexión.

En esta sección

Secciones relacionadas

Para obtener más información, vea:

Especificación del lenguaje C#

Para obtener más información, vea la Especificación del lenguaje C#. La especificación del lenguaje es la fuente definitiva de la sintaxis y el uso de C#.

Vea también

Conceptos

Guía de programación de C#