指另一个描述源代码中的类型和成员的文件。
语法
<include file="filename" path="tagpath[@name='id']" />
参数
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。
示例:
此示例使用标记从名为 commentFile.xml
<include>
的文件导入成员文档注释。
''' <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>