<include> (C#-Programmierhandbuch)

Artikel
09/03/2008

Aktualisiert: November 2007

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

Parameter

filename
der Name der Datei, die die Dokumentation enthält. Der Dateiname kann mit einem Pfad gekennzeichnet sein. filename muss in einfache Anführungszeichen (' ') eingeschlossen werden.
tagpath
Der Pfad der Tags in filename, der zum name-Tag führt. Der Pfad muss in einfache Anführungszeichen (' ') eingeschlossen werden.
name
Der Namensbezeichner in dem Tag, das sich vor den Kommentaren befindet. name weist eine id auf.
id
die ID für das Tag, das sich vor den Kommentaren befindet. Die ID muss in doppelte Anführungszeichen (" ") eingeschlossen werden.

Hinweise

Mit dem <include>-Tag kann auf Kommentare in anderen Dateien verwiesen werden, die die Typen und Member im Quellcode beschreiben. Dies stellt eine Alternative zum direkten Positionieren der Dokumentationskommentare in Quellcodedateien dar.

Das <include>-Tag verwendet die XPath-Syntax von XML. Weitere Informationen zu Anpassungsmöglichkeiten der Verwendung von <include> finden Sie in der XPath-Dokumentation.

Beispiel

Hierbei handelt es sich um ein Beispiel mit mehreren Dateien. Es folgt die Auflistung des Inhalts der ersten Datei, in der <include> verwendet wird:

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

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

Programmausgabe

<?xml version="1.0"?>

<doc>

<name>xml_include_tag</name>

</assembly>

The summary for this type.

</summary>

</member>

The summary for this other type.

</summary>

</member>

</members>

</doc>

Siehe auch

Konzepte

C#-Programmierhandbuch

Referenz

Empfohlene Tags für Dokumentationskommentare (C#-Programmierhandbuch)

Freigeben über