/doc (Przetwarzaj komentarze dokumentacji) (C/C++)
Powoduje, że kompilator przetwarza komentarze dokumentacji w plikach kodu źródłowego i tworzy plik xdc dla każdego pliku kodu źródłowego zawierającego komentarze dokumentacji.
Składnia
/doc[name]
Argumenty
name
Nazwa pliku xdc, który zostanie utworzony przez kompilator. Tylko wtedy, gdy jeden plik .cpp jest przekazywany w kompilacji.
Uwagi
Pliki xdc są przetwarzane do pliku .xml przy użyciu xdcmake.exe. Aby uzyskać więcej informacji, zobacz XDCMake Reference (Dokumentacja narzędzia XDCMake).
Komentarze dokumentacji można dodawać do plików kodu źródłowego. Aby uzyskać więcej informacji, zobacz Zalecane tagi dla komentarzy dokumentacji.
Aby użyć wygenerowanego pliku .xml z funkcją IntelliSense, ustaw nazwę pliku .xml na taki sam jak zestaw, który chcesz obsługiwać, i umieść plik .xml znajduje się w tym samym katalogu co zestaw. Po odwołaniu się do zestawu w projekcie programu Visual Studio zostanie również znaleziony plik .xml. Aby uzyskać więcej informacji, zobacz Using IntelliSense and Supplying XML Code Comments (Używanie funkcji IntelliSense i dostarczanie komentarzy kodu XML).
Aby ustawić tę opcję kompilatora w środowisku programowania Visual Studio
Otwórz okno dialogowe Strony właściwości projektu. Aby uzyskać szczegółowe informacje, zobacz Set C++ compiler and build properties in Visual Studio (Ustawianie właściwości kompilatora języka C++ i kompilowania w programie Visual Studio).
Wybierz stronę właściwości Właściwości>konfiguracji C/C++>Output Files.
Zmodyfikuj właściwość Generate XML Documentation Files (Generowanie plików dokumentacji XML).
Aby programowo ustawić tę opcję konsolidatora
- Zobacz: GenerateXMLDocumentationFiles.
Zobacz też
Opcje kompilatora MSVC
Składnia wiersza polecenia kompilatora MSVC