Share via

<include> (Visual Basic)

  • Article

Mise à jour : novembre 2007

Fait référence à un autre fichier qui décrit les types et membres dans votre code source.

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

Paramètres

  • filename
    Requis. Nom du fichier contenant la documentation. Le nom du fichier peut être précisé par un chemin. Mettez filename entre guillemets doubles (" ").

  • tagpath
    Requis. Chemin d'accès des balises dans filename qui permet d'accéder au name de la balise. Mettez le chemin d'accès entre guillemets doubles (" ").

  • name
    Requis. Dans la balise, spécificateur de nom précédant les commentaires. Name est associé à un id.

  • id
    Requis. ID de la balise qui précède les commentaires. Mettez l'ID entre guillemets simples (' ').

Notes

Utilisez la balise <include> pour faire référence à des commentaires situés dans un autre fichier qui décrivent les types et membres dans votre code source. Cette solution remplace celle consistant à placer des commentaires de documentation directement dans votre fichier de code source.

La balise <include> utilise la recommandation du W3C intitulée XML Path Language (XPath) Version 1.0. Plus d'informations sur les moyens de personnaliser votre utilisation de <include> sont disponibles à la page http://www.w3.org/TR/xpath.

Exemple

Cet exemple utilise la balise <include> pour importer des commentaires de documentation membre d'un fichier nommé 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 du 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>

Voir aussi

Référence

Balises XML recommandées pour les commentaires de documentation (Visual Basic)