Etiquetas XML recomendadas para comentarios de documentación (Visual Basic)
El Visual Basic puede procesar los comentarios de documentación del código en un archivo XML. Puede usar herramientas adicionales para procesar el archivo XML en la documentación.
Se permiten comentarios XML 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 se pueden aplicar a espacios de nombres. El motivo es que un espacio de nombres puede abarcar varios ensamblados y no todos los ensamblados tienen que cargarse al mismo tiempo.
El compilador procesa cualquier etiqueta que sea XML válido. Las etiquetas siguientes proporcionan funcionalidad de uso frecuente en la documentación del usuario.
- <c>
- <code>
- <example>
- <exception>1
- <include>1
- <list>
- <para>
- <param>1
- <paramref>
- <permission>1
- <remarks>
- <returns>
- <see>1
- <seealso>1
- <summary>
- <typeparam>1
- <value>
(1 El compilador comprueba la sintaxis).
Nota
Si desea que los corchetes angulares aparezcan 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> .