Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
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 se permiten 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:
No se pueden aplicar comentarios de documentación 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álida. Las etiquetas siguientes proporcionan funciones de uso general en la documentación de usuario.
- <c>
- <código>
- <ejemplo>
- <excepción>1
- <include>1
- <lista>
- <para>
- <param>1
- <paramref>
- <permiso>1
- <observaciones>
- <Devuelve>
- <ver>1
- <seealso>1
- <resumen>
- <typeparam>1
- <typeparamref>
- <valor>
(1 El compilador comprueba la sintaxis).
Nota:
Si desea 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>.
Consulte también
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.
