Dokumentacja XML (Visual C++)
W programie Visual C++można dodawać komentarze do kodu źródłowego przetwarzanego do pliku dokumentacji XML. Ten plik może następnie być danymi wejściowymi procesu, który tworzy dokumentację dla klas w kodzie.
W pliku kodu Visual C++ komentarze dokumentacji XML muszą znajdować się bezpośrednio przed definicją metody lub typu. Komentarze mogą służyć do wypełniania porady szybkich informacji funkcji IntelliSense w następujących scenariuszach:
Gdy kod jest kompilowany jako składnik środowisko wykonawcze systemu Windows z plikiem WINMD
Gdy kod źródłowy jest uwzględniony w bieżącym projekcie
W bibliotece, której deklaracje typów i implementacje znajdują się w tym samym pliku nagłówka
Uwaga
W bieżącej wersji komentarze kodu nie są przetwarzane na szablonach ani na niczego zawierającego typ szablonu (na przykład funkcja przyjmująca parametr jako szablon). Dodanie takich komentarzy spowoduje niezdefiniowane zachowanie.
Aby uzyskać szczegółowe informacje na temat tworzenia pliku XML z komentarzami dokumentacji, zobacz następujące artykuły.
| Aby uzyskać informacje o | Zobacz |
|---|---|
| Opcje kompilatora do użycia | /doc |
| Tagi, których można użyć do udostępniania powszechnie używanych funkcji w dokumentacji | Zalecane tagi dla komentarzy dokumentacji |
| Ciągi identyfikatorów tworzone przez kompilator w celu zidentyfikowania konstrukcji w kodzie | Przetwarzanie pliku XML |
| Jak rozdzielić tagi dokumentacji | Ograniczniki tagów dokumentacji visual C++ |
| Generowanie pliku XML z co najmniej jednego pliku XDC. | Dokumentacja narzędzia XDCMake |
| Linki do informacji o kodzie XML w odniesieniu do obszarów funkcji programu Visual Studio | Xml w programie Visual Studio |
Jeśli musisz umieścić znaki specjalne XML w tekście komentarza dokumentacji, musisz użyć jednostek XML lub sekcji CDATA.
Zobacz też
Rozszerzenia składników dla platform środowiska uruchomieniowego