<include> ドキュメント タグ
<include> タグを使用すると、ソース コード内の型とメンバーを記述する別のファイル内のコメントを参照することができます。 このタグは、ドキュメント コメントをソース コード ファイル内に直接配置する方法の代替です。 たとえば、<include> を使用し、チームまたは会社全体で使用する標準の "定型" コメントを挿入できます。
構文
/// <include file='filename' path='tag-path[@name="ID"' />
パラメーター
filename
文書を含むファイルの名前。 ファイル名をパスで修飾することができます。 名前は、一重引用符または二重引用符で囲みます。 コンパイラでは、filename が見つからない場合に警告を発行します。
tag-path
ファイルに含まれている目的のノードセットを選択する有効な XPath 式。
name
コメントの前に配置するタグの名前指定子。name には ID が指定されます。
ID
コメントの前に配置するタグの ID。 ID は、一重引用符または二重引用符で囲みます。
解説
<include> タグは XML XPath 構文を使用します。 <include> の使用をカスタマイズする方法については、XPath に関するドキュメントを参照してください。
コンパイル時に /doc を指定して、ドキュメント コメントをファイルに出力します。
例
この例では、複数のファイルを使用します。 <include> を使用する最初のファイルには、次のドキュメント コメントが含まれています。
// xml_include_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_include_tag.dll
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
public ref class Test {
void TestMethod() {
}
};
/// <include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test2"]/*' />
public ref class Test2 {
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>t2</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>