Compartilhar via

<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
    Required. 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
    Required. O caminho das marcas em filename que leva a marca de name. Coloque o caminho entre aspas duplas (" ").

  • name
    Required. O nome especificador na marca que precede os comentários. Nameterá um id.

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

Comentários

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

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

Exemplo

Este exemplo usa o <include> marca para importar comentários de documentação de 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 de commentFile.xml é como segue:

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