Bagikan melalui

Tag yang direkomendasikan untuk komentar dokumentasi

  • Artikel

Pengkompilasi MSVC memproses komentar dokumentasi dalam kode Anda untuk membuat file XDC untuk setiap file sumber yang dikompilasi. Kemudian, xdcmake.exe memproses file XDC untuk membuat file dokumentasi XML. Memproses file XML untuk membuat dokumentasi adalah detail yang perlu diimplementasikan di situs Anda.

Tag diproses pada konstruksi seperti jenis dan anggota jenis.

Tag harus segera mendahului jenis atau anggota.

Catatan

Komentar dokumentasi tidak dapat diterapkan ke namespace layanan atau definisi di luar baris untuk properti dan peristiwa; komentar dokumentasi harus ada di deklarasi dalam kelas.

Pengkompilasi akan memproses tag apa pun yang merupakan XML yang valid. Tag berikut menyediakan fungsionalitas yang umum digunakan dalam dokumentasi pengguna:

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

  1. Pengkompilasi memverifikasi sintaksis.

Dalam rilis saat ini, pengkompilasi MSVC tidak mendukung <paramref>, tag yang didukung oleh pengkompilasi Visual Studio lainnya. Visual C++ dapat mendukung <paramref> dalam rilis mendatang.

Baca juga

Dokumentasi XML