<include> (Visual Basic)
Odkazuje na jiný soubor, který popisuje typy a členy ve zdrojovém kódu.
Syntaxe
<include file="filename" path="tagpath[@name='id']" />
Parametry
filename
Povinný: Název souboru obsahujícího dokumentaci. Název souboru lze kvalifikovat cestou. Uzavřete filename do uvozovek (" ").
tagpath
Povinný: Cesta značek filename , které vedou ke značce name. Uzavřete cestu do dvojitých uvozovek (" ").
name
Povinný: Specifikátor názvu ve značce, která předchází komentářům. Namebude mít .id
id
Povinný: ID značky, která předchází komentářům. Uzavřete ID do jednoduchých uvozovek (' ').
Poznámky
Pomocí značky <include> můžete odkazovat na komentáře v jiném souboru, který popisuje typy a členy ve zdrojovém kódu. Toto je alternativa k umístění komentářů dokumentace přímo do souboru zdrojového kódu.
Značka <include> používá doporučení jazyka XPath (W3C XML Path Language) verze 1.0. Další informace o způsobech přizpůsobení <include> použití naleznete v tématu https://www.w3.org/TR/xpath.
Příklad
V tomto příkladu se <include> značka používá k importu komentářů dokumentace členů 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 je commentFile.xml 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>
