<include> (Visual Basic)

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

構文

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

パラメーター

filename
必須。 ドキュメントを含むファイルの名前。 ファイル名はパスで修飾できます。 filenameを二重引用符 (" ") で囲みます。

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

name
必須。 コメントの前にあるタグ内の名前指定子。 Name には idがあります。

id
必須。 コメントの前にあるタグの 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 コメント タグ