<include> (Visual Basic)

  • Artigo

Refere-se a outro arquivo que descreve os tipos e membros em seu código-fonte.

Sintaxe

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

Parâmetros

filename
Obrigatórios. O nome do arquivo que contém a documentação. O nome do arquivo pode ser qualificado com um caminho. Coloque filename entre aspas duplas (" ").

tagpath
Obrigatórios. O caminho das marcas em filename que leva à marca name. Coloque o caminho entre aspas duplas (" ").

name
Obrigatórios. O especificador de nome na marca que precede os comentários. Name terá um id.

id
Obrigatórios. A ID da marca que precede os comentários. Coloque a ID entre aspas simples (' ').

Comentários

Use a marca <include> para consultar comentários em outro arquivo que descreve os tipos e membros em seu código-fonte. Essa é uma alternativa para inserir comentários de documentação diretamente em seu arquivo de código-fonte.

A marca <include> usa a recomendação da linguagem XPath do W3C versão 1.0. Para obter mais informações sobre formas de personalizar o uso do seu <include>, confira https://www.w3.org/TR/xpath.

Exemplo

Este exemplo usa a marca <include> para importar comentários da documentação do membro de um arquivo chamado 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

O formato do commentFile.xml é o seguinte.

<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>

Confira também