<list> y <listheader> etiquetas de documentación

El bloque <listheader> se usa para definir la fila de encabezado de una tabla o de una lista de definiciones. Cuando se define una tabla, solo es necesario suministrar una entrada para un término en el encabezado.

Sintaxis

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

Parámetros

term
Término que se define en description.

description
Elemento de una lista numerada o con viñetas, o definición de un term.

Comentarios

Cada elemento de la lista se especifica con un bloque <item>. Cuando se crea una lista de definiciones, es necesario especificar tanto term como description. En cambio, para una tabla, lista con viñetas o lista numerada, solo es necesario suministrar una entrada para description.

Una lista o una tabla pueden tener tantos bloques <item> como sean necesarios.

Compile con /doc para procesar los comentarios de documentación a un archivo.

Ejemplo

// 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 {};

Vea también

Documentación de XML