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

Actualización: noviembre 2007

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.

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

• Etiquetas recomendadas para comentarios de documentación

• Procesar el archivo XML

• Delimitadores para etiquetas de documentación

• Cómo: Utilizar las características de documentación XML (Guía de programación de C#)

Secciones relacionadas

Para obtener más información al respecto, vea:

• /doc (procesar comentarios de documentación)

• Ejemplo XML Documentation

Especificación del lenguaje C#

Para obtener más información, vea las secciones siguientes de Especificación del lenguaje C#.

• Apéndice A Comentarios de la documentación

Vea también

Conceptos

Guía de programación de C#