<include> (Visual Basic)

Hace referencia a otro archivo que describe los tipos y miembros del código fuente.

Sintaxis

<include file="filename" path="tagpath[@name='id']" />  

Parámetros

filename
Obligatorio. Nombre del archivo que contiene la documentación. El nombre de archivo se puede calificar con una ruta de acceso. Encerrar entre filename comillas dobles (" ").

tagpath
Obligatorio. Ruta de acceso de las etiquetas de filename que conduce a la etiqueta name. Incluya la ruta de acceso entre comillas dobles (" ").

name
Obligatorio. Especificador de nombre en la etiqueta que precede a los comentarios. Name tendrá un id.

id
Obligatorio. Identificador de la etiqueta que precede a los comentarios. Encierre el identificador entre comillas simples (' ').

Observaciones

Use la <include> etiqueta para hacer referencia a los comentarios de otro archivo que describen los tipos y miembros del código fuente. Esta es una alternativa a colocar comentarios de documentación directamente en el archivo de código fuente.

La <include> etiqueta usa la recomendación W3C XML Path Language (XPath) Version 1.0. Para obtener más información sobre las formas de personalizar el <include> uso, consulte https://www.w3.org/TR/xpath.

Ejemplo

En este ejemplo se usa la <include> etiqueta para importar comentarios de documentación de miembros de un archivo denominado commentFile.xml.

''' <include file="commentFile.xml"
''' path="Docs/Members[@name='Open']/*" />
Public Sub Open(ByVal filename As String)
    ' Code goes here.
End Sub
''' <include file="commentFile.xml"
''' path="Docs/Members[@name='Close']/*" />
Public Sub Close(ByVal filename As String)
    ' Code goes here.
End Sub

El formato de commentFile.xml es el siguiente.

<Docs>  
<Members name="Open">  
<summary>Opens a file.</summary>  
<param name="filename">File name to open.</param>  
</Members>  
<Members name="Close">  
<summary>Closes a file.</summary>  
<param name="filename">File name to close.</param>  
</Members>  
</Docs>  

Consulte también

• Etiquetas de comentario XML