<include> (C# プログラミング ガイド)
更新 : 2007 年 11 月
<include file='filename' path='tagpath[@name="id"]' />
パラメータ
filename
ドキュメントを含むファイルの名前。ファイル名にパスを指定することもできます。filename は、単一引用符 (' ') で囲みます。tagpath
filename のタグのパス。その後ろにタグの name を指定します。パスは、単一引用符 (' ') で囲みます。name
タグの名前指定子。その後ろにコメントを指定します。name には id を指定します。id
タグの ID。その後ろにコメントを指定します。ID は、二重引用符 (" ") で囲みます。
解説
<include> タグを使用すると、ソース コード内の型およびメンバの説明として、別のファイル内のコメントを参照できます。これはソース コードのファイルにドキュメント コメントを直接記述しない方法です。
<include> タグは、XML の XPath 構文を使用します。<include> タグのカスタマイズ方法については、XPath に関するドキュメントを参照してください。
使用例
複数ファイルの例を次に示します。最初のファイルは、次のように <include> タグを使用しています。
// compile with: /doc:DocFileName.xml
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
class Test
{
static void Main()
{
}
}
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
class Test2
{
public void Test()
{
}
}
2 番目のファイル xml_include_tag.doc には、次のドキュメント コメントが記述されています。
<MyDocs>
<MyMembers name="test">
<summary>
The summary for this type.
</summary>
</MyMembers>
<MyMembers name="test2">
<summary>
The summary for this other type.
</summary>
</MyMembers>
</MyDocs>
プログラムの出力
<?xml version="1.0"?>
<doc>
<assembly>
<name>xml_include_tag</name>
</assembly>
<members>
<member name="T:Test">
<summary>
The summary for this type.
</summary>
</member>
<member name="T:Test2">
<summary>
The summary for this other type.
</summary>
</member>
</members>
</doc>