<include> (Visual C++)
<include> znacznik umożliwia odnoszą się do komentarzy w innym pliku, które opisują typy i elementy członkowskie w kodzie źródłowym.Jest to alternatywa do umieszczania komentarzy dokumentacji bezpośrednio w pliku kodu źródłowego.Na przykład, można użyć <include> Wstawianie komentarzy standardowego "standardowego", które są używane w obrębie zespołu lub firmy.
<include file='filename' path='tagpath' />
Parametry
filename
Nazwa pliku zawierającego w dokumentacji.Nazwa pliku może zostać zakwalifikowany ze ścieżką.Nazwę ująć w pojedynczy lub podwójny cudzysłów.Kompilator generuje ostrzeżenie, jeśli nie znajdzie filename.tagpath
Prawidłowe wyrażenie XPath, który wybiera żądany zestaw węzłów zawarte w pliku.name
Specyfikator nazwy w tagu, który poprzedza uwag; namebędą miały id.id
Identyfikator tagu, który poprzedza komentarze.Nazwę ująć w pojedynczy lub podwójny cudzysłów.
Uwagi
<include> Tag używa składni XML XPath.Zajrzyj do dokumentacji XPath o sposobach dostosowywania, przy użyciu <include>.
Kompilacji z /doc do procesu komentarzy dokumentacji do pliku.
Przykład
Jest to przykład wieloplikowe.Pierwszy plik, który korzysta z <include>, zawiera następujące uwagi dokumentacji:
// 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() {
}
};
Drugi plik, xml_include_tag.doc, zawiera następujące uwagi dokumentacji:
<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>
Dane wyjściowe 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>