<include> (Visual Basic)
ソース コード内の型やメンバーを記述する別のファイルを参照します。
<include file="filename" path="tagpath[@name='id']" />
パラメーター
filename
必ず指定します。ドキュメントを含むファイルの名前。ファイル名にパスを指定することもできます。filename は二重引用符 (" ") で囲みます。tagpath
必ず指定します。filename のタグのパス。その後ろにタグの 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>