<include>
tag dokumentacji
Tag <include>
umożliwia odwoływanie się do komentarzy w innym pliku, które opisują typy i elementy członkowskie w kodzie źródłowym. Ten tag jest alternatywą dla umieszczania komentarzy dokumentacji bezpośrednio w pliku kodu źródłowego. Można na przykład użyć <include>
polecenia , aby wstawić standardowe komentarze "standardowy" używane w całym zespole lub firmie.
Składnia
/// <include file='filename' path='tag-path[@name="ID"' />
Parametry
filename
Nazwa pliku zawierającego dokumentację. Nazwę pliku można zakwalifikować za pomocą ścieżki. Ujęć nazwę w pojedynczych lub podwójnych cudzysłowach. Kompilator wyświetla ostrzeżenie, jeśli nie znajdzie filename
elementu .
tag-path
Prawidłowe wyrażenie XPath, które wybiera żądany zestaw węzłów zawarty w pliku.
name
Specyfikator nazwy w tagu poprzedzającym komentarze; name
element będzie miał element ID
.
ID
Identyfikator tagu, który poprzedza komentarze. Ujmij identyfikator w pojedynczych lub podwójnych cudzysłowach.
Uwagi
Tag <include>
używa składni XPath XML. Zapoznaj się z dokumentacją programu XPath, aby uzyskać informacje na temat sposobów dostosowywania przy użyciu programu <include>
.
Skompiluj element , /doc
aby przetworzyć komentarze dokumentacji do pliku.
Przykład
W tym przykładzie użyto wielu plików. Pierwszy plik, który używa <include>
metody , zawiera następujące komentarze do 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 komentarze 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>
Zobacz też
Opinia
https://aka.ms/ContentUserFeedback.
Dostępne już wkrótce: W 2024 r. będziemy stopniowo wycofywać zgłoszenia z serwisu GitHub jako mechanizm przesyłania opinii na temat zawartości i zastępować go nowym systemem opinii. Aby uzyskać więcej informacji, sprawdź:Prześlij i wyświetl opinię dla