Belge açıklamaları için önerilen etiketler

MSVC derleyicisi, derlenen her kaynak dosya için bir XDC dosyası oluşturmak üzere kodunuzdaki belge açıklamalarını işler. Ardından, xdcmake.exe bir XML belge dosyası oluşturmak için XDC dosyalarını işler. Belge oluşturmak için XML dosyasının işlenmesi, sitenizde uygulanması gereken bir ayrıntıdır.

Etiketler tür ve tür üyeleri gibi yapılarda işlenir.

Etiketlerin türlerin veya üyelerin hemen önüne çıkması gerekir.

Dekont

Belge açıklamaları bir ad alanına veya özellikler ve olaylar için satır dışı tanımlara uygulanamaz; belge açıklamaları sınıf içi bildirimlerde olmalıdır.

Derleyici geçerli XML olan herhangi bir etiketi işler. Aşağıdaki etiketler kullanıcı belgelerinde yaygın olarak kullanılan işlevleri sağlar:

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

1. Derleyici söz dizimlerini doğrular.

Geçerli sürümde, MSVC derleyicisi diğer Visual Studio derleyicileri tarafından desteklenen bir etiketi desteklemez <paramref>. Visual C++ gelecek bir sürümde destek <paramref> verebilir.

Ayrıca bkz.

XML belgeleri