<include> (Visual Basic)

ソース コード内の型とメンバーを記述する別のファイルを参照します。

構文

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

パラメーター

filename
必須です。 文書を含むファイルの名前。 ファイル名をパスで修飾することができます。 filename は二重引用符 (" ") で囲みます。

tagpath
必須です。 タグ name につながる filename 内のタグのパス。 パスは二重引用符 (" ") で囲みます。

name
必須です。 コメントの前に配置するタグの名前指定子。 Name には id が指定されます。

id
必須です。 コメントの前に配置するタグの ID。 ID は単一引用符 (' ') で囲みます。

Remarks

<include> タグを使用して、ソース コード内の型とメンバーを記述する別のファイル内のコメントを参照します。 これは文書化のコメントをソース コード ファイル内に直接配置する方法の代替です。

<include> タグでは、W3C XML Path Language (XPath) Version 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 のコメント用タグ