Condividi tramite

<include> (Visual Basic)

  • Articolo

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 che contiene la documentazione. È possibile qualificare il nome del file con un percorso. Racchiudere filename tra virgolette doppie (" ").

tagpath
Obbligatorio. Percorso dei tag di filename che porta al name del tag. Racchiudere il percorso tra virgolette doppie (" ").

name
Obbligatorio. Identificatore del nome contenuto nel tag che precede i commenti. Name ha sempre un id.

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

Osservazioni:

Usare il tag <include> per fare riferimento ai commenti di un altro file per la descrizione dei tipi e dei membri del codice sorgente. eliminando la necessità di inserire i commenti relativi alla documentazione direttamente nel file del codice sorgente.

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

Esempio

In questo esempio viene usato il tag <include> 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>

Vedi anche