Ejemplo XML Documentation

Actualización: noviembre 2007

En este ejemplo se muestra cómo documentar código mediante XML. Para obtener más información, consulte Comentarios de documentación XML (Guía de programación de C#).

Para obtener ejemplos e instrucciones para la instalación

• Siga uno o varios de los procedimientos siguientes:

  • En el menú Ayuda, haga clic en Ejemplos.

    El archivo Léame muestra información sobre los ejemplos.

  • Visite el sitio web Visual Studio 2008 Samples. Están disponibles las versiones de ejemplos más recientes.

  • Busque los ejemplos en el equipo en el que está instalado Visual Studio. De manera predeterminada, los ejemplos y el archivo Léame se instalan en unidad:\Archivos de programa\Microsoft Visual Studio 9.0\Samples\lcid. Para las versiones Express de Visual Studio, todos los ejemplos están en línea.

Para obtener más información, vea Localizar archivos de ejemplo.

.

Nota de seguridad:

En este ejemplo de código se ilustra un concepto y únicamente se muestra el código correspondiente a dicho concepto. Es posible que no cumpla los requisitos de seguridad de un entorno concreto y, por tanto, no debería utilizarse tal y como se muestra. Se recomienda agregar código de seguridad y de control de errores para que los proyectos sean más seguros y sólidos. Microsoft proporciona este ejemplo "tal cual" sin ninguna garantía.

Para generar el ejemplo XML Documentation en Visual Studio

1. En el Explorador de soluciones, haga clic con el botón secundario del mouse en el proyecto y, a continuación, seleccione Propiedades.

2. Abra la carpeta Propiedades de configuración y, a continuación, haga clic en Generar.

3. Establezca la propiedad Archivo de documentación XML en XMLsample.xml.

4. En el menú Generar, haga clic en Generar.

   El archivo XML de resultados se situará en el directorio debug.

Para generar el ejemplo de documentación XML desde un símbolo del sistema

1. Para generar la documentación XML de ejemplo, escriba lo siguiente en un símbolo del sistema:

   csc XMLsample.cs /doc:XMLsample.xml
   

2. Para ver el XML generado, escriba el comando siguiente:

   type XMLsample.xml
   

Vea también

Tareas

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

Conceptos

Ejemplos de Visual C#

Guía de programación de C#