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

El compilador de Visual Basic puede procesar comentarios de documentación en el código en un archivo XML. Puede usar herramientas adicionales para procesar el archivo XML en la documentación.

Los comentarios XML están permitidos en construcciones de código como tipos y miembros de tipo. En el caso de los tipos parciales, solo una parte del tipo puede tener comentarios XML, aunque no hay ninguna restricción para comentar sus miembros.

Nota

Los comentarios de documentación no pueden aplicarse a espacios de nombres. El motivo es que un espacio de nombres puede abarcar varios ensamblados, y no todos los ensamblados deben cargarse al mismo tiempo.

El compilador procesa cualquier etiqueta que sea XML válido. Las etiquetas siguientes proporcionan funciones de uso general en la documentación de usuario.

• <c>
• <code>
• <example>
• <exception>¹
• <include>¹
• <list>
• <para>
• <param>¹
• <paramref>
• <permission>¹
• <remarks>
• <returns>
• <see>¹
• <seealso>¹
• <summary>
• <typeparam>¹
• <value>

(¹ El compilador comprueba la sintaxis).

Nota

Si quiere que aparezcan corchetes angulares en el texto de un comentario de documentación, use < y >. Por ejemplo, la cadena "<text in angle brackets>" aparecerá como <text in angle brackets>.

Vea también

• Documentar el código con XML
• -doc
• Procedimiento para crear documentación XML