<include> (Visual Basic)

在其他文件中引用描述源代码中类型和成员的注释。

语法

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

parameters

filename
必需。 包含文档的文件的名称。 可使用路径来限定文件名。 将 filename 包含在双引号 (" ") 内。

tagpath
必需。 filename 中标记的路径，它指向标记 name。 将路径包含在双引号 (" ") 内。

name
必需。 标记中的名称说明符（位于注释之前）。 Name 将有 id。

id
必需。 标记的 ID（位于注释之前）。 将 ID 包含在单引号 (' ') 内。

注解

使用 <include> 标记，可在其他文件中引用描述源代码中类型和成员的注释。 这是对直接在源代码文件中放入文档注释的替代方法。

<include> 标记使用 W3C XML 路径语言 (XPath) 版本 1.0 建议。 有关自定义 <include> 使用方式的详细信息，请参阅 https://www.w3.org/TR/xpath。

示例

此示例使用 <include> 标记从名为 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

commentFile.xml 的格式如下。

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

另请参阅

• XML 注释标记