Zalecane tagi przeznaczone do komentarzy dokumentacji

  • Artykuł

Kompilator MSVC przetwarza komentarze dokumentacji w kodzie, aby utworzyć plik XDC dla każdego skompilowanego pliku źródłowego. Następnie plik xdcmake.exe przetwarza pliki XDC w celu utworzenia pliku dokumentacji XML. Przetwarzanie pliku XML w celu utworzenia dokumentacji to szczegóły, które należy zaimplementować w danej lokacji.

Tagi są przetwarzane na konstrukcjach, takich jak typy i składowe typów.

Tagi muszą natychmiast poprzedzać typy lub elementy członkowskie.

Uwaga

Komentarze dokumentacji nie mogą być stosowane do przestrzeni nazw ani poza definicjami wierszy dla właściwości i zdarzeń; komentarze dokumentacji muszą znajdować się w deklaracjach w klasie.

Kompilator przetworzy dowolny tag, który jest prawidłowym kodem XML. Następujące tagi udostępniają często używane funkcje w dokumentacji użytkownika:

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

  1. Kompilator weryfikuje składnię.

W bieżącej wersji kompilator MSVC nie obsługuje <paramref>tagu obsługiwanego przez inne kompilatory programu Visual Studio. Język Visual C++ może obsługiwać <paramref> w przyszłej wersji.

Zobacz też

Dokumentacja XML