Dokumentacja XML (Visual C++)

W programie Visual C++ mogą dodawać komentarze do kodu źródłowego, które będą przetwarzane do pliku .xml.Ten plik może być następnie dane wejściowe do procesu, który tworzy dokumentację dla klas w kodzie.

W pliku kodu Visual C++ komentarzy dokumentacji XML musi być umieszczony bezpośrednio przed definicji metody lub typu.Komentarze można zapełnić Wskazówka danych Intellisense skrócone informacje w następujących scenariuszach:

1. Kiedy ten kod został skompilowany jako składnik Windows Runtime z towarzyszący pliku .winmd

2. Kiedy kod źródłowy znajduje się w bieżącym projekcie

3. w bibliotece, w których deklaracje typu i implementacje znajdują się w tym samym pliku nagłówka

[!UWAGA]

W bieżącej wersji komentarze do kodu nie są przetwarzane na szablony lub coś zawierające typ szablonu (na przykład funkcja biorąc parametr jako szablon).Dodanie takich uwag spowoduje zachowanie niezdefiniowany.

Aby uzyskać szczegółowe informacje na temat tworzenia pliku XML z komentarzami dokumentacji zobacz następujące tematy.

Aby uzyskać informacje o	Zobacz
Opcje kompilatora, aby użyć	/doc
Tagi, których można użyć, aby zapewnić powszechnie używane funkcje w dokumentacji	Zaleca się znaczniki komentarzy dokumentacji
Ciągi identyfikatorów, które kompilator generuje do identyfikowania konstrukcje w kodzie	Przetwarzanie pliku .xml
Sposobu wyznaczania tagi dokumentacji	Ograniczniki Visual C++ dokumentacji tagów
Trwa generowanie pliku XML z jednego lub więcej plików .xdc.	Odwołanie XDCMake
Łącza do informacji dotyczących XML w postaci, w jakiej odnosi się do obszarów funkcji Visual Studio	XML w programie Visual Studio

Jeśli trzeba umieścić XML znaki specjalne w tekście komentarza dokumentacji, należy użyć jednostki XML lub sekcja CDATA.

Zobacz też

Koncepcje

Składnik rozszerzeń dla platform Runtime