共用方式為


<include> (Visual Basic)

更新:2007 年 11 月

請參閱另一個檔案中原始程式碼之型別和成員的說明。

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

參數

  • filename
    必要項。為含有文件的檔案名稱。可將檔案名稱加上路徑。以雙引號 (" ") 將 filename 括起來。

  • tagpath
    必要項。filename 中導向標記 (Tag) name 的標記路徑。以雙引號 (" ") 將路徑括起來。

  • name
    必要項。註解前之標記內的名稱規範。Name 會有 id。

  • id
    必要項。註解前面之標記的 ID。以單引號 (' ') 將 ID 括起來。

備註

使用 <include> 標記來參考其他檔案內的註解,這些檔案描述了您原始程式碼中的型別及成員。除了將文件註解直接放置在您原始程式碼檔案中,您也可以使用這種方法。

<include> 標記會使用<W3C XML Path Language (XPath) Version 1.0 Recommendation>。如需如何自訂 <include> 用途的詳細資訊,請造訪 http://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 標記 (Visual Basic)