<include> (Visual Basic)

參考另一個描述原始程式碼中的類型和成員的檔案。

語法

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

參數

filename
必要。 包含文件的檔案名稱。 檔案名稱可以使用路徑進行限定。 以雙引號 (" ") 括住 filename。

tagpath
必要。 filename 中導致 name 標記的標記路徑。 以雙引號 (" ") 括住路徑。

name
必要。 標記中位在註解前面的名稱規範。 Name 會有 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 註解標籤