Bagikan melalui


<list> dan <listheader> tag dokumentasi

Blok <listheader> digunakan untuk menentukan baris judul tabel atau daftar definisi. Saat menentukan tabel, Anda hanya perlu menyediakan entri untuk istilah dalam judul.

Sintaks

<list type="bullet" | "number" | "table">
   <listheader>
      <term>term</term>
      <description>description</description>
   </listheader>
   <item>
      <term>term</term>
      <description>description</description>
   </item>
</list>

Parameter

term
Istilah yang akan ditentukan, yang akan didefinisikan dalam description.

description
Item dalam daftar poin atau bernomor atau definisi term.

Keterangan

Setiap item dalam daftar ditentukan dengan blok <item>. Saat membuat daftar definisi, Anda harus menentukan term dan description. Namun, untuk tabel, daftar berpoin, atau daftar bernomor, Anda hanya perlu memasukkan entri untuk description.

Daftar atau tabel dapat memiliki blok <item> sebanyak yang diperlukan.

Kompilasi dengan /doc untuk memproses komentar dokumentasi ke file.

Contoh

// xml_list_tag.cpp
// compile with: /doc /LD
// post-build command: xdcmake xml_list_tag.dll
/// <remarks>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// </remarks>
class MyClass {};

Lihat juga

Dokumentasi XML