Marcas recomendadas para comentários de documentação

O compilador MSVC processa comentários de documentação em seu código para criar um arquivo XDC para cada arquivo de origem compilado. Em seguida, xdcmake.exe processa os arquivos XDC para criar um arquivo de documentação XML. O processamento do arquivo XML para criar a documentação é um detalhe que precisa ser implementado no site.

As marcas são processadas em constructos, como tipos e membros de tipo.

As marcas precisam preceder imediatamente tipos ou membros.

Observação

Os comentários da documentação não podem ser aplicados a um namespace ou à definição fora de linha de propriedades e eventos; os comentários da documentação precisam ser aplicados às declarações na classe.

O compilador processará qualquer marca que seja um XML válido. As seguintes marcas fornecem as funcionalidades geralmente usadas na documentação do usuário:

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

1. O compilador verifica a sintaxe.

Na versão atual, o compilador do MSVC não dá suporte a <paramref>, uma marcação compatível com outros compiladores do Visual Studio. O Visual C++ poderá dar suporte a <paramref> em uma versão futura.

Confira também

Documentação XML