Compartir a través de

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

  • Artículo

El compilador de Visual Basic puede procesar los comentarios de documentación del código en un archivo XML. Puede utilizar herramientas adicionales para procesar el archivo XML en forma de documentación.

Los comentarios XML están permitidos en construcciones de código, tales como tipos y miembros de tipos. Para los tipos parciales, sólo una parte del tipo puede tener comentarios XML, aunque no hay ninguna restricción para marcar sus miembros como comentarios.

Nota

Los comentarios de la documentación no se pueden aplicar a los espacios de nombres.La razón 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 válida en XML. Las siguientes etiquetas proporcionan la funcionalidad habitual en la documentación de 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 aparezcan corchetes angulares en el texto de un comentario de la documentación, utilice &lt; y &gt;.Por ejemplo, la cadena "&lt;text in angle brackets&gt;" aparecerá como <text in angle brackets>.

Vea también

Tareas

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

Referencia

/doc

Conceptos

Documentar el código con XML (Visual Basic)