<include> (Visual Basic)

  • Artigo

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

<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.Coloque filename entre aspas duplas ("").

  • tagpath
    Obrigatório.O caminho nas marcas filename que leva a marca de name.Coloque o caminho entre aspas duplas ("").

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

  • id
    Obrigatório.A identificação de marca que precede os comentários.Coloque a identificação de aspas simples (' ').

Comentários

Use o <include> marca para se referir a comentários em outro arquivo que descrevem os tipos e membros em seu código-fonte.Essa é uma alternativa à colocação de comentários da documentação diretamente no seu arquivo de código-fonte.

O <include> marca usa a recomendação versão 1.0 do W3C XML Path Language (XPath).Mais informações sobre maneiras de personalizar seu <include> uso está disponível em http://www.w3.org/TR/xpath.

Exemplo

Este exemplo usa a <include> marca para importar comentários de 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>

Consulte também

Referência

Recomendado marcas XML para comentários da documentação (Visual Basic)