<include> (Visual C++)
<include> tag umožňuje odkazovat na komentáře v jiném souboru, které popisují typy a členy ve zdrojovém kódu.Jedná se o alternativu k uvádění dokumentační komentáře přímo do vašeho zdrojového souboru kódu.Například můžete použít <include> Chcete-li vložit standardní "standardní" komentáře, které se používají v celém týmu nebo společnosti.
<include file='filename' path='tagpath' />
Parametry
filename
Název souboru, který obsahuje dokumentaci.Název souboru může kvalifikovaný s cestou.Název uzavřete do jednoduchých nebo dvojitých uvozovek.Kompilátor vydá upozornění, pokud se nenajde filename.tagpath
Platný výraz XPath, který vybere požadovaný node-set obsažené v souboru.name
Specifikátor název značky, který předchází komentáře; namebude mít id.id
ID pro značku, která předchází komentáře.Název uzavřete do jednoduchých nebo dvojitých uvozovek.
Poznámky
<include> značka používá syntaxi XML XPath.Výraz XPath dokumentaci pro přizpůsobení pomocí <include>.
Kompilace s /doc k procesu dokumentační komentáře do souboru.
Příklad
Toto je vícesouborové příklad.První soubor, který používá <include>, obsahuje následující dokumentační komentáře:
// 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, xml_include_tag.doc, obsahuje následující dokumentační komentáře:
<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>