-doc

  • Článek

Zpracovává komentáře dokumentace k souboru XML.

Syntaxe

-doc[+ | -]

nebo

-doc:file

Argumenty

Pojem definice
+ | - Nepovinné. Zadání +, nebo jen -doc, způsobí, že kompilátor vygeneruje informace dokumentace a umístí je do souboru XML. - Určení je ekvivalentem nezadání -doc, což způsobuje, že se nevytvořily žádné informace o dokumentaci.
file Vyžaduje se, pokud -doc: se používá. Určuje výstupní soubor XML, který se naplní komentáři ze zdrojových souborů kompilace. Pokud název souboru obsahuje mezeru, zadejte název do uvozovek (" ").

Poznámky

Možnost -doc určuje, jestli kompilátor generuje soubor XML obsahující komentáře dokumentace. Pokud použijete -doc:file syntaxi, file parametr určuje název souboru XML. Pokud použijete -doc nebo -doc+, kompilátor převezme název souboru XML ze spustitelného souboru nebo knihovny, kterou kompilátor vytváří. Pokud použijete -doc- nebo nezadáte -doc možnost, kompilátor nevytvoří soubor XML.

V souborech zdrojového kódu mohou komentáře dokumentace předcházet následující definice:

Pokud chcete použít vygenerovaný soubor XML s funkcí IntelliSense sady Visual Studio, nechte název souboru XML stejný jako sestavení, které chcete podporovat. Ujistěte se, že soubor XML je ve stejném adresáři jako sestavení, aby při odkazování na sestavení v projektu sady Visual Studio byl nalezen i soubor .xml. Soubory dokumentace XML nejsou vyžadovány, aby IntelliSense fungovala pro kód v rámci projektu nebo v projektech odkazovaných projektem.

Pokud ho zkompilujete -target:module, soubor XML obsahuje značky <assembly></assembly>. Tyto značky určují název souboru obsahujícího manifest sestavení pro výstupní soubor kompilace.

Způsoby generování dokumentace z komentářů v kódu najdete v tématu Značky komentářů XML.

Nastavení -doc v integrovaném vývojovém prostředí sady Visual Studio
1. Vyberte projekt v Průzkumník řešení. V nabídce Projekt klepněte na příkaz Vlastnosti.
2. Klikněte na kartu Kompilace .
3. Nastavte hodnotu v poli Generovat soubor dokumentace XML.

Příklad

Ukázku najdete v dokumentaci kódu pomocí KÓDU XML .

Viz také