<enthalten> (Visual Basic)

  • Artikel

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

Syntax

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

Parameter

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

tagpath
Erforderlich. Der Pfad der Tags in filename, der zum Tag name führt. Setzen Sie den Pfad in doppelte Anführungszeichen („ “).

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

id
Erforderlich. Die ID für das Tag, das sich vor den Kommentaren befindet. 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 der 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 tag <include> verwendet, um Kommentare zur Memberdokumentation aus einer Datei mit dem Namen commentFile.xml zu importieren.

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