Documentação XML (Visual C++)

Em Visual C++, você pode adicionar comentários ao código-fonte que será processado para um arquivo .xml.Este arquivo pode ser entrada a um processo que criar documentação para as classes em seu código.

Em um arquivo de código Visual C++, comentários de documentação XML devem ser localizadas diretamente antes de um método ou uma definição de tipo.Comentários podem ser usados para preencher a dica de dados do Intellisense QuickInfo nas seguintes situações:

1. quando o código é compilado como um componente de Tempo de Execução do Windows com um arquivo de rastreamento de .winmd

2. quando o código-fonte está incluído no projeto atual

3. em uma biblioteca cujas declarações e as implementações de tipo são posicionadas no mesmo arquivo de cabeçalho

Observação
Na versão atual, os comentários de código não são processados nos modelos ou em qualquer coisa que contêm um tipo de modelo (por exemplo, uma função que aceita um parâmetro como um modelo).Como adicionar comentários resultará em comportamento indefinido.

Para obter detalhes sobre como criar um arquivo .xml com comentários de documentação, consulte os seguintes tópicos.

Para obter informações sobre LINQ	Consulte
As opções de compilador usar	/doc
Marcas que você pode usar para fornecer funcionalidades comumente usadas na documentação	Marcas recomendadas para comentários de documentação
As cadeias de caracteres de identificação que o compilador gera para identificar as compilações no seu código	Processando o arquivo.xml
Como limitar marcas de documentação	Delimitadores para marcas de documentação do Visual C++
Gerando um arquivo .xml de um ou mais arquivos de .xdc.	Referência de XDCMake
Links para informações sobre XML como ele se relaciona as áreas de recurso do Visual Studio	XML no Visual Studio

Se você precisa colocar XML caracteres especiais no texto de um comentário de documentação, você deve usar entidades XML ou uma seção CDATA.

Consulte também

Conceitos

Extensões de componente para plataformas de tempo de execução