<include> (Visual Basic)

Fa riferimento a un altro file che descrive i tipi e i membri nel codice sorgente.

Sintassi

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

Parametri

filename
Obbligatorio. Nome del file contenente la documentazione. Il nome del file può essere qualificato con un percorso. Racchiudere filename tra virgolette doppie (" ").

tagpath
Obbligatorio. Percorso dei tag in filename che conduce al tag name. Racchiudere il percorso tra virgolette doppie (" ").

name
Obbligatorio. Identificatore di nome nel tag che precede i commenti. Name avrà un oggetto id.

id
Obbligatorio. ID del tag che precede i commenti. Racchiudere l'ID tra virgolette singole (' ').

Osservazioni:

Usare il <include> tag per fare riferimento ai commenti in un altro file che descrivono i tipi e i membri nel codice sorgente. Si tratta di un'alternativa all'inserimento dei commenti della documentazione direttamente nel file del codice sorgente.

Il <include> tag usa la raccomandazione W3C XML Path Language (XPath) versione 1.0. Per altre informazioni sui modi per personalizzare l'uso <include> , vedere https://www.w3.org/TR/xpath.

Esempio

In questo esempio viene usato il <include> tag per importare i commenti della documentazione dei membri da un file denominato 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

Il formato di commentFile.xml è il seguente.

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

Vedere anche

• Tag di commento XML