Partilhar via

Marcas recomendadas para comentários da documentação (Visual C++)

  • Artigo

O compilador do Visual C++ processará comentários de documentação em seu código e cria um arquivo de .xdc para cada compiland, e xdcmake.exe processará os arquivos de .xdc a um arquivo .xml.Processar o arquivo .xml para criar documentação é um detalhe que precisa ser implementado em seu site.

As marcas são processadas em compilações como tipos e membros do tipo.

As marcas deve imediatamente preceder tipos ou membros.

ObservaçãoObservação

Comentários de documentação não podem ser aplicados a um namespace ou sobre fora da linha definição de propriedades e eventos; comentários de documentação devem nas declarações de em- classe.

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

<c>

<código>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>1

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<value>

 

 

1.O compilador verifica a sintaxe.

Na versão atual, o compilador Visual C++ não oferece suporte <paramref>, uma marca que é suportada por outros compiladores do Visual Studio.Visual C++ pode suportar <paramref> em uma versão futura.

Consulte também

Outros recursos

Documentação XML (Visual C++)