Sdílet prostřednictvím

<include> (Visual Basic)

  • Článek

Odkazuje na jiný soubor, který popisuje typy a členy ve zdrojovém kódu.

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

Parametry

  • filename
    Povinné.Název souboru obsahuje dokumentaci.Název souboru můžete kvalifikované cestu.Uzavřete filename v uvozovkách ("").

  • tagpath
    Povinné.Cesta značek v filename , které vedou k tag name.Uzavřete cestu do uvozovek ("").

  • name
    Povinné.Specifikátor název značky, který předchází komentáře.Namebude mít id.

  • id
    Povinné.ID pro značku, která předchází komentáře.ID uvádějte v apostrofech (' ').

Poznámky

Použití <include> značky odkazovat v jiném souboru komentáře, které popisují typy a členy ve zdrojovém kódu.Jedná se o alternativu k umístění komentáře k dokumentaci přímo v souboru zdrojový kód.

<include> Používá tag doporučení W3C XML Path Language (XPath) verze 1.0.Další informace o přizpůsobení vašeho <include> použití je k dispozici na adrese http://www.w3.org/TR/xpath.

Příklad

V tomto příkladu <include> značky komentáře k dokumentaci členského importovat ze souboru s názvem 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

Formát commentFile.xml je následující.

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

Viz také

Referenční dokumentace

Doporučené značky XML pro komentáře k dokumentaci (Visual Basic)