/doc (zpracování dokumentačních komentářů) (C/C++)

  • Článek

Způsobí, že kompilátor zpracuje komentáře dokumentace v souborech zdrojového kódu a vytvoří soubor .xdc pro každý soubor zdrojového kódu, který má komentáře k dokumentaci.

Syntaxe

/doc[name]

Argumenty

Jméno
Název souboru .xdc, který kompilátor vytvoří. Platné pouze při předání jednoho souboru .cpp v kompilaci.

Poznámky

Soubory .xdc jsou zpracovány do souboru .xml s xdcmake.exe. Další informace naleznete v tématu XDCMake Reference.

Do souborů zdrojového kódu můžete přidat komentáře k dokumentaci. Další informace najdete v tématu Doporučené značky pro komentáře dokumentace.

Chcete-li použít vygenerovaný soubor .xml s technologií IntelliSense, nastavte název souboru .xml stejný jako sestavení, které chcete podporovat, a vložte soubor .xml do stejného adresáře jako sestavení. Pokud je sestavení odkazováno v projektu sady Visual Studio, soubor .xml je také nalezen. Další informace najdete v tématu Použití technologie IntelliSense a zadávání komentářů ke kódu XML.

Nastavení tohoto parametru kompilátoru ve vývojovém prostředí Visual Studio

  1. Otevřete dialogové okno Stránky vlastností projektu. Podrobnosti najdete v tématu Nastavení kompilátoru C++ a vlastností sestavení v sadě Visual Studio.

  2. Vyberte stránku vlastností vlastnosti>konfigurace C/C++>Výstupní soubory.

  3. Upravte vlastnost Generovat soubory dokumentace XML.

Programové nastavení tohoto parametru linkeru

Viz také

Parametry kompilátoru MSVC
Syntaxe příkazového řádku kompilátoru MSVC