<include> (Visual Basic)

Refererar till en annan fil som beskriver typerna och medlemmarna i källkoden.

Syntax

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

Parameterar

filename
Obligatoriskt. Namnet på filen som innehåller dokumentationen. Filnamnet kan kvalificeras med en sökväg. Omslut inom filename dubbla citattecken (" ").

tagpath
Obligatoriskt. Sökvägen till taggarna i filename som leder till taggen name. Omslut sökvägen inom dubbla citattecken (" ").

name
Obligatoriskt. Namnspecificeraren i taggen som föregår kommentarerna. Name kommer att ha en id.

id
Obligatoriskt. ID:t för taggen som föregår kommentarerna. Omslut ID:t med enkla citattecken (' ').

Anmärkningar

Använd taggen <include> för att referera till kommentarer i en annan fil som beskriver typerna och medlemmarna i källkoden. Det här är ett alternativ till att placera dokumentationskommentar direkt i källkodsfilen.

Taggen <include> använder rekommendationen W3C XML Path Language (XPath) version 1.0. Mer information om hur du anpassar din <include> användning finns i https://www.w3.org/TR/xpath.

Exempel

I det här exemplet används taggen <include> för att importera kommentarer från medlemsdokumentationen från en fil med namnet 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

Formatet för commentFile.xml är följande.

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

Se även

• XML-kommentarstaggar