Compartir a través de

<include> (Visual Basic)

  • Artículo

Actualización: noviembre 2007

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

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

Parámetros

  • filename
    Requerido. Nombre del archivo que contiene la documentación. El nombre de archivo se puede completar con una ruta de acceso. Agregue filename entre comillas (" ").

  • tagpath
    Requerido. Ruta de acceso de las etiquetas de filename que conduce a la etiqueta name. Agregue la ruta entre comillas (" ").

  • name
    Requerido. Especificador de nombre en la etiqueta que precede a los comentarios. Name poseerá un id.

  • id
    Requerido. Identificador para la etiqueta que precede a los comentarios. Agregue el identificador entre comillas simples (' ').

Comentarios

Utilice la etiqueta <include> para hacer referencia a comentarios colocados en otro archivo que describen los tipos y miembros del código fuente. Ésta es una alternativa al método habitual de colocar los comentarios de la documentación directamente en el archivo de código fuente.

La etiqueta <include> utiliza la recomendación W3C XML Path Language (XPath) Versión 1.0. Para obtener más información sobre formas de personalizar el uso de <include>, puede ver http://www.w3.org/TR/xpath.

Ejemplo

Este ejemplo utiliza la etiqueta <include> para importar comentarios de documentación del miembro 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>

Vea también

Referencia

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