/doc (Možnosti C# kompilátoru)
Možnost /doc umožňuje umístit dokumentační komentáře do souboru jazyka XML.
/doc:file
Argumenty
- file
Výstupní soubor jazyka XML, který je naplněn komentáři ze souborů zdrojového kódu dané kompilace.
Poznámky
Do souboru jazyka XML mohou být zpracovány a přidány dokumentační komentáře ze souborů zdrojových kódů, které předcházejí následující:
Soubor zdrojového kódu, který obsahuje Main, je do souboru jazyka XML zaveden jako první.
Chcete-li vygenerovaný soubor jazyka XML použít s funkcí IntelliSense, ponechte název souboru jazyka XML stejný jako název sestavení, které má být podporováno a ujistěte se, že se soubor jazyka XML nachází ve stejném adresáři jako dané sestavení. Tak bude při odkázání na dané sestavení v projektu aplikace Visual Studio, nalezen také soubor jazyka XML. Pro další informace, shlédněte Podporované komentáře kódu.
Pokud nekompilujete s /target:module, file bude obsahovat značku <assembly></assembly> určující název souboru obsahujícího manifest sestavení pro výstupní soubor kompilace.
Poznámka
Možnost /doc platí pro všechny vstupní soubory; nebo všechny soubory projektu, pokud je tak v nastaveních daného projektu nastaveno. Chcete-li vypnout upozornění týkající se dokumentačních poznámek pro konkrétní soubor nebo část kódu, použijte #pragma warning.
Pro způsoby jak generovat dokumentaci z komentářů v kódu, shlédněte Doporučené značky pro dokumentační komentáře.
Chcete-li nastavit tuto možnost kompilátoru ve vývojovém prostředí Visual Studio
Otevřete stránku Vlastnosti daného projektu.
Upravte vlastnost Soubor dokumentace jazyka XML.
Informace o nastavení této možnosti kompilátoru v programu naleznete v tématu DocumentationFile.