Partager via

<Include> (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’accès. filename Placer entre guillemets doubles ( » « ).

tagpath
Obligatoire. Chemin d’accès des balises qui filename mène à la balise name. Placez le chemin entre guillemets doubles ( » « ).

name
Obligatoire. Spécificateur de nom 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. Placez l’ID entre guillemets simples (' ').

Remarques

Utilisez la <include> balise pour faire référence à des commentaires dans un autre fichier qui décrivent les types et les membres de votre code source. Il s’agit d’une alternative au placement de commentaires de documentation directement dans votre fichier de code source.

La <include> balise utilise la recommandation W3C XML Path Language (XPath) Version 1.0. Pour plus d’informations sur les façons de personnaliser votre <include> utilisation, consultez https://www.w3.org/TR/xpath.

Exemple :

Cet exemple utilise la balise pour importer des <include> 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 du fichier 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

  • Last updated on