Marcas de documentação <list>
e <listheader>
O bloco <listheader>
é usado para definir a linha de cabeçalho de uma tabela ou lista de definição. Ao definir uma tabela, é necessário fornecer uma entrada para o termo no título.
Sintaxe
<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
Um termo a se definir, que será definido em description
.
description
Um item em uma lista com marcadores ou numerada ou uma definição de um term
.
Comentários
Cada item na lista é especificado com um bloco <item>
. Ao criar uma lista de definições, será necessário especificar term
e description
. No entanto, para uma tabela, lista com marcadores ou lista numerada, será necessário fornecer apenas uma entrada para description
.
Uma lista ou tabela pode ter quantos blocos <item>
forem necessários.
Compile com /doc
para processar comentários de documentação em um arquivo.
Exemplo
// 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 {};
Confira também
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários