<include> (Visual Basic)

Egy másik fájlra hivatkozik, amely leírja a forráskód típusait és tagjait.

Szemantika

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

Paraméterek

filename
Szükséges. A dokumentációt tartalmazó fájl neve. A fájlnév egy elérési úttal minősíthető. Idézőjelek filename közé (" ").

tagpath
Szükséges. A címkéhez filenamenamevezető címkék elérési útja. Az elérési utat idézőjelek közé kell foglalni (" ").

name
Szükséges. A megjegyzéseket megelőző címke névkijelölője. Name lesz egy id.

id
Szükséges. A megjegyzéseket megelőző címke azonosítója. Az azonosítót idézőjelek közé (' ') kell foglalnia.

Megjegyzések

<include> A címkével egy másik fájlban található megjegyzésekre hivatkozhat, amelyek a forráskódban szereplő típusokat és tagokat írják le. Ez egy alternatíva a dokumentációs megjegyzések közvetlen elhelyezésére a forráskódfájlban.

A <include> címke a W3C XML Path Language (XPath) 1.0-s verziójára vonatkozó javaslatot használja. További információ a használat testreszabásának <include> módjáról: https://www.w3.org/TR/xpath.

példa

Ez a példa a címkével importálja a <include> tagdokumentáció megjegyzéseit egy nevű commentFile.xmlfájlból.

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

A formátum a commentFile.xml következő.

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

Lásd még

• XML-megjegyzéscímkék