Freigeben über

<include> Dokumentationstag

  • Artikel

Mit dem <include>-Tag können Sie auf Kommentare in einer anderen Datei verweisen, in denen die Typen und Member in Ihrem Quellcode beschrieben werden. Dieses Tag ist eine Alternative zum Direkten Platzieren von Dokumentationskommentaren in Ihrer Quellcodedatei. Sie können <include> z. B. standardkommentare "Textbausteine" einfügen, die in Ihrem Gesamten Team oder Unternehmen verwendet werden.

Syntax

/// <include file='filename' path='tag-path[@name="ID"' />

Parameter

filename
Der Name der Datei, die die Dokumentation enthält. Der Dateiname kann mit einem Pfad qualifiziert werden. Setzen Sie den Namen in einfache oder doppelte Anführungszeichen. Der Compiler gibt eine Warnung aus, wenn er nicht gefunden filenamewird.

tag-path
Ein gültiger XPath-Ausdruck, der den gewünschten Knotensatz in der Datei auswählt.

name
Der Namensbezeichner in dem Tag, das sich vor den Kommentaren befindet. name besitzt eine ID.

ID
Die ID für das Tag, das sich vor den Kommentaren befindet. Schließen Sie die ID in einfache oder doppelte Anführungszeichen ein.

Hinweise

Das <include>-Tag verwendet die XPath-Syntax. Weitere Informationen zum Anpassen mithilfe von <include>XPath finden Sie in der XPath-Dokumentation.

Kompilieren sie, /doc um Dokumentationskommentare in einer Datei zu verarbeiten.

Beispiel

In diesem Beispiel werden mehrere Dateien verwendet. Die erste Datei, die verwendet <include>wird, enthält die folgenden Dokumentationskommentare:

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

Die zweite Datei enthält xml_include_tag.docdie 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>
    <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>

Siehe auch

XML-Dokumentation