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

  • Artículo

En este ejemplo se muestra cómo agregar comentarios de documentación XML al código.

Nota:

Es posible que tu equipo muestre nombres o ubicaciones diferentes para algunos de los elementos de la interfaz de usuario de Visual Studio en las siguientes instrucciones. La edición de Visual Studio que se tenga y la configuración que se utilice determinan estos elementos. Para obtener más información, vea Personalizar el IDE.

Para crear documentación XML para un tipo o miembro

  1. En el Editor de código, coloque el cursor en la línea situada encima del tipo o miembro para el que desea crear la documentación.

  2. Tipo ''' (tres comillas simples).

    Se agrega un esqueleto XML para el tipo o miembro en el Editor de código.

  3. Agregue información descriptiva entre las etiquetas adecuadas.

    Nota

    Si agrega líneas adicionales dentro del bloque de documentación XML, cada línea debe comenzar por '''.

  4. Agregue código adicional que use el tipo o el miembro con los nuevos comentarios de documentación XML.

    IntelliSense muestra el texto de la etiqueta <summary> del tipo o miembro.

  5. Compile el código para generar un archivo XML que contenga los comentarios de documentación. Para obtener más información, vea -doc.

Vea también