<include> (Visual Basic)

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ório O nome do arquivo que contém a documentação. O nome do arquivo pode ser qualificado com um caminho. filename Coloque entre aspas duplas (" ").

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

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

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

Observações

Use a <include> marca para fazer referência a comentários em outro arquivo que descreva os tipos e membros em seu código-fonte. Essa é uma alternativa para colocar comentários de documentação diretamente em seu arquivo de código-fonte.

A <include> marca usa a recomendação XPath (Linguagem de Caminho XML) W3C versão 1.0. Para obter mais informações sobre maneiras de personalizar seu <include> uso, consulte https://www.w3.org/TR/xpath.

Exemplo

Este exemplo usa a <include> marca 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 é o commentFile.xml 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>  

Consulte também

• Marcas de comentário XML