Compartir a través de


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

Actualización: noviembre 2007

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

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. Escriba ''' (tres comillas simples).

    Se agrega una estructura 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 con '''.

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

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

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

Vea también

Conceptos

Documentar el código con XML (Visual Basic)

Referencia

Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)

/doc