<inclure> (Visual Basic)
Fait référence à un autre fichier qui décrit les types et les membres dans votre code source.
Syntaxe
<include file="filename" path="tagpath[@name='id']" />
Paramètres
filename
Obligatoire. Nom du fichier contenant la documentation. Le nom de fichier peut être qualifié avec un chemin. Délimité filename par des guillemets doubles (" ").
tagpath
Obligatoire. Chemin des balises contenues dans filename qui mène à la balise name. Mettez le chemin d’accès entre guillemets doubles (" ").
name
Obligatoire. Le spécificateur de nom contenu dans la balise qui précède les commentaires. Name aura un id.
id
Obligatoire. ID de la balise qui précède les commentaires. Mettez l’identifiant entre guillemets simples (' ').
Notes
Utilisez la balise <include> pour faire référence à des commentaires dans un autre fichier qui décrivent les types et les membres dans votre code source. Il s’agit d’une solution alternative au placement direct des commentaires de la documentation dans votre fichier de code source.
La balise <include> utilise la recommandation W3C XML Path Language (XPath) version 1.0. Pour plus d’informations sur les façons de personnaliser votre utilisation <include>, consultez https://www.w3.org/TR/xpath.
Exemple
Cet exemple utilise la balise <include> pour importer des commentaires de documentation de membre à partir d’un fichier appelé 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
Le format de commentFile.xml est le suivant.
<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>
