Compartir vía

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

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

Nota:

El equipo puede mostrar nombres o ubicaciones diferentes para algunos de los elementos de la interfaz de usuario de Visual Studio en las instrucciones siguientes. La edición de Visual Studio que tiene y la configuración que usa determinan estos elementos. Para obtener más información, consulte Personalizando 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 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 elemento acompañado de nuevos comentarios de documentación XML.

    IntelliSense muestra el texto de la <etiqueta de resumen> 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, consulte -doc.

Consulte también