Compartir a través de


Ejemplo XML Comments

Actualización: noviembre 2007

Este ejemplo muestra la característica de comentarios XML de Visual Basic.

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 ejecutar este ejemplo

  • Presione F5.

Demostraciones

En este ejemplo se muestra la creación de comentarios XML, su presentación en el editor y el acceso a ellos mediante programación.

La clase Automobile define los siguientes elementos de tipo, cada uno de los cuales muestra un aspecto diferente de los comentarios XML:

  • TiposAutomobile y EngineOption

  • Propiedades   Model

  • Métodos   Constructores, Upgrade, CalculateMaxTowing, WillItTow

  • Eventos   NeedsTuneUp

  • Delegados   RotateTires, ReplaceSparkPlugs

  • Campos   car, modelValue

El controlador de eventos Click para el botón Crear automóvil llama a algunos de los miembros de Automobile. Al utilizar IntelliSense en el Editor de código, los comentarios XML se muestran como información sobre herramientas.

El controlador de eventos Click para el botón Enumerar resúmenes utiliza la clase XmlDocument para consultar el archivo XML que contiene los comentarios XML. Cuando se compila el proyecto, se crea este archivo XML y se almacena con el ensamblado del proyecto. La ficha Compilar del Diseñador de proyectos permite especificar la ubicación y el nombre de este archivo.

Vea también

Tareas

Cómo: Crear documentación XML en Visual Basic