Dokumentace XML (Visual C++)

V jazyce Visual C++ můžete do zdrojového kódu přidávat komentáře, které se zpracovávají do souboru dokumentace XML. Tento soubor pak může být vstupem procesu, který vytvoří dokumentaci pro třídy v kódu.

V souboru kódu jazyka Visual C++ musí být komentáře dokumentace XML umístěny přímo před definicí metody nebo typu. Komentáře lze použít k naplnění datového tipu Rychlé informace Technologie IntelliSense v následujících scénářích:

1. Při kompilaci kódu jako komponenty prostředí Windows Runtime se souborem WINMD

2. Při zahrnutí zdrojového kódu do aktuálního projektu

3. V knihovně, jejíž deklarace typů a implementace jsou umístěny ve stejném souboru hlaviček.

Poznámka

V aktuální verzi se komentáře ke kódu nezpracují v šablonách ani nic obsahujícím typ šablony (například funkce, která přebírá parametr jako šablonu). Přidání takových komentářů způsobí nedefinované chování.

Podrobnosti o vytvoření souboru XML s komentáři k dokumentaci najdete v následujících článcích.

Informace o	Seznamte se s
Možnosti kompilátoru, které se mají použít	/doc
Značky, které můžete použít k poskytování běžně používaných funkcí v dokumentaci	Doporučené značky pro komentáře dokumentace
Řetězce ID, které kompilátor vytvoří k identifikaci konstruktorů v kódu	Zpracování souboru XML
Jak oddělovat značky dokumentace	Oddělovače pro značky dokumentace visual C++
Generování souboru XML z jednoho nebo více souborů XDC	Referenční dokumentace XDCMake
Odkazy na informace o jazyce XML, protože souvisí s oblastmi funkcí sady Visual Studio	XML v sadě Visual Studio

Pokud potřebujete do textu komentáře dokumentace vložit speciální znaky XML, musíte použít entity XML nebo oddíl CDATA.

Viz také

Rozšíření komponent pro platformy modulu runtime