Doporučené značky pro komentáře dokumentace

Kompilátor MSVC zpracovává komentáře dokumentace v kódu k vytvoření souboru XDC pro každý zkompilovaný zdrojový soubor. Xdcmake.exe pak zpracuje soubory XDC k vytvoření souboru dokumentace XML. Zpracování souboru XML za účelem vytvoření dokumentace je podrobnosti, které je potřeba implementovat na vašem webu.

Značky se zpracovávají u konstruktorů, jako jsou typy a členy typu.

Značky musí bezprostředně předcházet typům nebo členům.

Poznámka

Komentáře dokumentace nelze použít u oboru názvů ani u definic mimo řádky pro vlastnosti a události; komentáře k dokumentaci musí být v deklaracích v třídě.

Kompilátor zpracuje všechny značky, které jsou platné xml. Následující značky poskytují běžně používané funkce v uživatelské dokumentaci:

<c>
<code>
<example>
<exception>¹
<include>¹
<list>
<para>
<param>¹
<paramref>¹
<permission>¹
<remarks>
<returns>
<see>¹
<seealso>¹
<summary>
<value>

1. Kompilátor ověřuje syntaxi.

V aktuální verzi kompilátor MSVC nepodporuje <paramref>značku podporovanou jinými kompilátory sady Visual Studio. Visual C++ může podporovat <paramref> v budoucí verzi.

Viz také

Dokumentace XML