<include> (C#-Programmierhandbuch)<include> (C# Programming Guide)

SyntaxSyntax

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

ParameterParameters

filename
Der Name der XML-Datei, die die Dokumentation enthält.The name of the XML file containing the documentation. Der Dateiname kann mit einem Pfad qualifiziert werden.The file name can be qualified with a path. filename muss in einfache Anführungszeichen (‚‘) eingeschlossen werden.Enclose filename in single quotation marks (' ').

tagpath
Der Pfad der Tags in filename, der zum Tag name führt.The path of the tags in filename that leads to the tag name. Der Pfad muss in einfache Anführungszeichen (‚‘) eingeschlossen werden.Enclose the path in single quotation marks (' ').

name
Der Namensbezeichner in dem Tag, das sich vor den Kommentaren befindet. name besitzt eine id.The name specifier in the tag that precedes the comments; name will have an id.

id
Die ID für das Tag, das sich vor den Kommentaren befindet.The ID for the tag that precedes the comments. Die ID muss in doppelte Anführungszeichen („“) eingeschlossen werden.Enclose the ID in double quotation marks (" ").

HinweiseRemarks

Mit dem <include>-Tag können Sie auf Kommentare in einer anderen Datei verweisen, die die Typen und Member in Ihrem Quellcode beschreiben.The <include> tag lets you refer to comments in another file that describe the types and members in your source code. Dies ist eine Alternative zum direkten Platzieren von Dokumentationskommentaren in der Quellcodedatei.This is an alternative to placing documentation comments directly in your source code file. Durch das Ablegen der Dokumentation in einer separaten Datei können Sie die Quellcodeverwaltung unabhängig vom Quellcode auf die Dokumentation anwenden.By putting the documentation in a separate file, you can apply source control to the documentation separately from the source code. Eine Person kann die Quellcodedatei auschecken, eine andere die Dokumentationsdatei.One person can have the source code file checked out and someone else can have the documentation file checked out.

Das <include>-Tag verwendet die XPath-Syntax von XML.The <include> tag uses the XML XPath syntax. Weitere Anpassungsmöglichkeiten der Verwendung von <include> finden Sie in der XPath-Dokumentation.Refer to XPath documentation for ways to customize your <include> use.

BeispielExample

Dies ist ein Beispiel einer Mehrfachdatei.This is a multifile example. Die erste Datei, die <include> verwendet, wird unten aufgeführt:The first file, which uses <include>, is listed below:

// 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()
    {
    }
}

Die zweite Datei, xml_include_tag.doc, enthält die folgenden Dokumentationskommentare:The second file, xml_include_tag.doc, contains the following documentation comments:

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

ProgrammausgabeProgram Output

Die folgende Ausgabe wird generiert, wenn Sie die Klassen „Test“ und „Test2“ mit der folgenden Befehlszeile kompilieren: /doc:DocFileName.xml.. Geben Sie in Visual Studio im Bereich „Build“ des Projekt-Designers die Option XML-Dokumentkommentare an.The following output is generated when you compile the Test and Test2 classes with the following command line: /doc:DocFileName.xml. In Visual Studio, you specify the XML doc comments option in the Build pane of the Project Designer. Erkennt der C#-Compiler das <include>-Tag, sucht er statt in der aktuellen Quelldatei in „xml_include_tag.doc“ nach Dokumentationskommentaren.When the C# compiler sees the <include> tag, it will search for documentation comments in xml_include_tag.doc instead of the current source file. Der Compiler generiert dann DocFileName.xml. Dies ist die Datei, die von Dokumentationstools wie z.B. Sandcastle genutzt wird, um die endgültige Dokumentation zu erzeugen.The compiler then generates DocFileName.xml, and this is the file that is consumed by documentation tools such as Sandcastle to produce the final documentation.

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

Siehe auchSee Also

C#-ProgrammierhandbuchC# Programming Guide
Empfohlene Tags für DokumentationskommentareRecommended Tags for Documentation Comments