Share via

<include> (Visual Basic)

  • Artikel

Verweist auf eine andere Datei, in der die Typen und Member im Quellcode beschrieben werden.

<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 gekennzeichnet sein. filename muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

  • tagpath
    Erforderlich. Der Pfad der Tags in filename, der zum name-Tag führt. Der Pfad muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

  • name
    Erforderlich. Der Namensbezeichner in dem Tag, das sich vor den Kommentaren befindet. Name weist eine id auf.

  • id
    Erforderlich. die ID für das Tag, das sich vor den Kommentaren befindet. Die ID muss in einfache Anführungszeichen (' ') eingeschlossen werden.

Hinweise

Mit dem <include>-Tag kann auf Kommentare in anderen Dateien verwiesen werden, die die Typen und Member im Quellcode beschreiben. Dies stellt eine Alternative zum direkten Positionieren der Dokumentationskommentare in Quellcodedateien dar.

Das <include>-Tag entspricht der Empfehlung der W3C XML Path Language (XPath), Version 1.0. Weitere Informationen zu Möglichkeiten, die <include>-Verwendung anzupassen, finden Sie unter der Adresse http://www.w3.org/TR/xpath.

Beispiel

In diesem Beispiel wird das <include>-Tag verwendet, um Memberdokumentationskommentare 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

Die Datei commentFile.xml hat folgendes Format.

<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

Referenz

Empfohlene XML-Tags für Dokumentationskommentare (Visual Basic)