Udostępnij za pośrednictwem

Znaczniki zalecane dla komentarzy do dokumentacji (Visual C++)

  • Artykuł

Kompilator Visual C++ będzie przetwarzać komentarzy dokumentacji w kodzie i tworzy plik .xdc dla każdego compiland i xdcmake.exe będzie przetwarzać pliki .xdc do pliku .xml.Przetwarzanie pliku XML do tworzenia dokumentacji jest szczegółów, który musi być realizowane na poziomie witryny.

Tagi są przetwarzane na konstrukcje, takie jak typy i wpisz członków.

Tagi musi być typu lub elementy członkowskie.

[!UWAGA]

Dokumentacja komentarzy nie można zastosować do obszaru nazw lub z z definicji wiersza dla właściwości i zdarzeń; komentarze dokumentacji musi w deklaracjach w swojej klasie.

Kompilator będzie przetwarzać dowolny znacznik, który jest prawidłowy dokument XML.Poniższe numery seryjne oferują funkcje często używane 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 sprawdza składnię.

W bieżącej wersji kompilatora Visual C++ nie obsługuje <paramref>, znacznik, który jest obsługiwany przez inne kompilatory Visual Studio.Visual C++ może obsługiwać <paramref> w przyszłym wydaniu.

Zobacz też

Inne zasoby

Dokumentacja XML (Visual C++)