Share via

<opnemen> (Visual Basic)

  • Artikel

Verwijst naar een ander bestand dat de typen en leden in uw broncode beschrijft.

Syntaxis

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

Parameters

filename
Vereist. De naam van het bestand met de documentatie. De bestandsnaam kan worden gekwalificeerd met een pad. Plaats deze tussen dubbele aanhalingstekens filename (" ").

tagpath
Vereist. Het pad van de tags in filename die leidt tot de tag name. Plaats het pad tussen dubbele aanhalingstekens (" ").

name
Vereist. De naamaanduiding in de tag die voorafgaat aan de opmerkingen. Name zal een id.

id
Vereist. De id voor de tag die voorafgaat aan de opmerkingen. Plaats de id tussen enkele aanhalingstekens (' ').

Opmerkingen

Gebruik de <include> tag om te verwijzen naar opmerkingen in een ander bestand waarin de typen en leden in uw broncode worden beschreven. Dit is een alternatief voor het rechtstreeks in uw broncodebestand plaatsen van documentatieopmerkingen.

De <include> tag maakt gebruik van de aanbeveling W3C XML Path Language (XPath) versie 1.0. Zie voor meer informatie over manieren om uw <include> gebruik https://www.w3.org/TR/xpathaan te passen.

Opmerking

In dit voorbeeld wordt de tag gebruikt om opmerkingen bij de ledendocumentatie te importeren uit een bestand met de <include> naam 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

De indeling van de commentFile.xml indeling is als volgt.

<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>

Zie ook