<include> (Visual Basic)

Verweist auf eine andere Datei, die die Typen und Member in Ihrem Quellcode beschreibt.

Syntax

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

Die Parameter

filename
Erforderlich. Der Name der Datei, die die Dokumentation enthält. Der Dateiname kann mit einem Pfad qualifiziert werden. filename Schließen Sie doppelte Anführungszeichen ein (" ").

tagpath
Erforderlich. Der Pfad der Tags, die filename zum Tag nameführt. Setzen Sie den Pfad in doppelte Anführungszeichen (" ").

name
Erforderlich. Der Namensbezeichner im Tag, der den Kommentaren vorausgeht. Name wird ein id.

id
Erforderlich. Die ID für das Tag, das den Kommentaren vorausgeht. Schließen Sie die ID in einfache Anführungszeichen (' ') ein.

Bemerkungen

Verwenden Sie das <include> Tag, um auf Kommentare in einer anderen Datei zu verweisen, die die Typen und Member in Ihrem Quellcode beschreiben. Dies ist eine Alternative zum Direkten Platzieren von Dokumentationskommentaren in Ihrer Quellcodedatei.

Das <include> Tag verwendet die W3C XML Path Language (XPath) Version 1.0-Empfehlung. Weitere Informationen zu Möglichkeiten zum Anpassen Ihrer <include> Verwendung finden Sie unter https://www.w3.org/TR/xpath.

Beispiel

In diesem Beispiel wird das <include> Tag zum Importieren von Memberdokumentationskommentaren aus einer Datei verwendet, die aufgerufen wird 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

Das Format der Datei commentFile.xml lautet wie folgt.

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

Siehe auch

• XML-Kommentartags