Sdílet prostřednictvím

Doporučené značky pro dokumentační komentáře (Visual C++)

  • Článek

Kompilátor Visual C++ bude zpracovávat dokumentační komentáře v kódu a vytvoří projektový soubor pro každého souboru určeného ke kompilaci a xdcmake.exe bude zpracovávat soubory projektový soubor XML.Zpracování souboru XML k vytvoření dokumentace je podrobností, která je implementována na váš web.

Značky jsou zpracovávány na konstrukcích, jako jsou typy a zadejte členů.

Značky musí bezprostředně předcházet, typy nebo členy.

[!POZNÁMKA]

Dokumentační komentáře nelze použít k oboru názvů nebo na mimo definici řádku pro vlastnosti a události; dokumentační komentáře musí být na ve třídě deklarací.

Kompilátor bude zpracovávat tag, který je platný kód XML.Následující značky poskytují běžně používané funkce v uživatelské dokumentaci:

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>1

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<value>

 

 

1.Kompilátor ověří syntaxi.

V současné verzi kompilátoru jazyka Visual C++ nepodporuje <paramref>, tag, který je podporován jinými kompilátory Visual Studio.Visual C++ může podporovat <paramref> v budoucí verzi.

Viz také

Další zdroje

XML dokumentace (Visual C++)