參考另一個檔案,描述原始程式碼中的類型和成員。
語法
<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>