Condividi tramite

<include> (Visual Basic)

  • Articolo

Fa riferimento a un altro file in cui sono descritti i tipi e i membri del codice sorgente.

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

Parametri

  • filename
    Obbligatorio. Nome del file che contiene la documentazione. È possibile qualificare il nome del file tramite 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 avrà un id.

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

Note

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

Il tag <include> utilizza la raccomandazione XML Path Language (XPath) Version 1.0 del WC3. Per ulteriori informazioni sulla personalizzazione di <include>, visitare il sito Web all'indirizzo http://www.w3.org/TR/xpath (informazioni in lingua inglese).

Esempio

Nell'esempio riportato di seguito il tag <include> viene utilizzato per importare i commenti relativi alla 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

Riferimenti

Tag XML consigliati per i commenti relativi alla documentazione (Visual Basic)