Sdílet prostřednictvím

<include> značka dokumentace

  • Článek

Značka <include> umožňuje odkazovat na komentáře v jiném souboru, který popisuje typy a členy ve zdrojovém kódu. Tato značka je alternativou k umístění komentářů dokumentace přímo do souboru zdrojového kódu. Můžete například vložit <include> standardní "často používané" komentáře, které se používají v celém týmu nebo společnosti.

Syntaxe

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

Parametry

filename
Název souboru obsahujícího dokumentaci. Název souboru lze kvalifikovat cestou. Uzavřete název do jednoduchých nebo dvojitých uvozovek. Kompilátor vydá upozornění, pokud ho nenajde filename.

tag-path
Platný výraz XPath, který vybere požadovanou sadu uzlů obsaženou v souboru.

name
Specifikátor názvu ve značce, která předchází komentářům; name bude mít .ID

ID
ID značky, která předchází komentářům. Uzavřete ID do jednoduchých nebo dvojitých uvozovek.

Poznámky

Značka <include> používá syntaxi XML XPath. Způsoby přizpůsobení pomocí nástroje XPath najdete v dokumentaci k XPathu <include>.

Zkompilujte je /doc pro zpracování komentářů dokumentace k souboru.

Příklad

Tento příklad používá více souborů. První soubor, který používá <include>, obsahuje následující poznámky k dokumentaci:

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

Druhý soubor obsahuje xml_include_tag.docnásledující komentáře k dokumentaci:

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

Výstup programu

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

Viz také

Dokumentace XML