<include> (C# プログラミング ガイド)

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

パラメーター

• filename
  ドキュメントを含む XML ファイルの名前。 ファイル名にパスを指定することもできます。 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>

プログラムの出力

次の出力は、「/doc:DocFileName.xml.」というコマンド ラインを使用して Test クラスと Test2 クラスをコンパイルしたときに生成されます。Visual Studio では、XML ドキュメント コメントのオプションはプロジェクト デザイナーの [ビルド] ペインで指定します。 C# コンパイラは、<include> タグを認識すると、現在のソース ファイルではなく xml_include_tag.doc でドキュメント コメントを検索します。 次に、コンパイラは DocFileName.xml を生成します。このファイルが Sandcastle などのドキュメント ツールで使用されて、最終的なドキュメントが生成されます。

<?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> 

参照

関連項目

ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)

概念

C# プログラミング ガイド