<include> (Visual Basic)

  • Artículo

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

Sintaxis

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

Parámetros

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

tagpath
Necesario. La ruta de acceso de las etiquetas de filename que conduce a la etiqueta name. Ponga la ruta de acceso entre comillas dobles (" ").

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

id
Necesario. El identificador de la etiqueta que precede a los comentarios. Incluya el id. de acceso entre comillas simples (' ').

Comentarios

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

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

Ejemplo

En este ejemplo se usa la etiqueta <include> para importar comentarios de documentación de miembros desde 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