/doc
Zpracovává dokumentaci komentáře do souboru XML.
/doc[+ | -]
' -or-
/doc:file
Arguments
Termín |
Definice |
+ | - |
Nepovinné.Určení +, nebo jen /doc, způsobí, že kompilátor generovat informace o dokumentaci a umístěte jej do souboru XML.Zadání - je ekvivalentem bez zadání /doc, žádné informace o dokumentaci k vytvoření způsobuje. |
file |
Vyžadován, pokud /doc: se používá.Určuje výstupní soubor XML, který je naplněn komentáře z kompilace souborů zdrojového kódu.Pokud název souboru obsahuje mezery, uzavřete název uvozovek (""). |
Poznámky
/doc Možnost kontroly, zda kompilátor vygeneruje soubor XML obsahující komentáře k dokumentaci.Používáte-li /doc:file syntaxe, file parametr určuje název souboru XML.Používáte-li /doc nebo /doc+, kompilátor trvá ze spustitelného souboru nebo knihovně, která vytváří kompilátor název souboru XML.Používáte-li /doc- nebo zadat /doc možnost, kompilátor nevytváří soubor XML.
Soubory zdrojového kódu komentáře k dokumentaci lze předcházet následující definice:
Členové, například do pole událost, Vlastnost, funkce, nebo podprogram.
Vygenerovaný soubor XML s použití Visual Studiotechnologie IntelliSense funkce, aby název souboru XML být stejné jako sestavení chcete podporovat. Přesvědčte se, zda je soubor XML ve stejném adresáři jako sestavení, aby při sestavení odkazuje Visual Studio projektu, souboru XML nachází také.XML soubory dokumentace nejsou vyžadovány pro technologie IntelliSense pro kód na projektu nebo projektů, které odkazují na projektu pracovat.
Pokud kompilace s /target:module, soubor XML obsahuje značky <assembly></assembly>.Tyto značky zadat název souboru obsahujícího manifestu sestavení kompilace výstupního souboru.
Viz Doporučené značky XML pro dokumentační komentáře (Visual Basic) způsoby generování dokumentace z komentáře v kódu.
/Doc nastavení v aplikaci Visual Studio integrované vývojové prostředí |
|
Příklad
Viz Dokumentace kódu s XML (Visual Basic) pro vzorek.
Viz také
Koncepty
Dokumentace kódu s XML (Visual Basic)