XML dokumentace (Visual C++)

V aplikaci Visual C++ můžete přidat komentáře do vašeho zdrojového kódu, který bude zpracována do souboru XML.Tento soubor lze poté vstup do procesu, který vytváří dokumentaci pro třídy v kódu.

V souboru kódu Visual C++ dokumentační komentáře XML musí být umístěn přímo před definici metody nebo typu.Komentáře lze použít k naplnění dat tip QuickInfo technologie Intellisense v následujících situacích:

1. Pokud kód je zkompilován jako součást Windows Runtime s doprovodný soubor .winmd

2. Pokud zdrojový kód je součástí aktuálního projektu

3. v knihovně, jehož typ deklarace a implementaci jsou umístěny ve stejném souboru záhlaví

[!POZNÁMKA]

V současné verzi nejsou zpracovány komentáře kódu šablony nebo obsahují typ šablony (například funkce převzetí parametr jako šablonu).Přidání takové připomínky, bude mít za následek nedefinované chování.

Další informace o vytváření souboru XML se dokumentačních poznámek naleznete v následujících tématech.

Informace o	Odkaz
Chcete-li použít možnosti kompilátoru	/doc
Značky, které můžete použít pro běžně používané funkce v dokumentaci	Doporučené značky pro dokumentační komentáře
ID řetězce, které vytváří kompilátor k identifikaci konstrukce ve vašem kódu	Zpracování souboru XML
Postup pro vymezení dokumentace značky	Oddělovače pro Visual C++ dokumentaci značky
Generování souboru XML z jednoho nebo více soubory.	XDCMake odkaz
Odkazy na informace o XML tak, jak se týká oblasti funkcí aplikace Visual Studio	XML v aplikaci Visual Studio

Pokud potřebujete vložit speciální znaky XML text komentáře dokumentace, je nutné použít entity XML nebo oddíl CDATA.

Viz také

Koncepty

Součást rozšíření pro Runtime platformy