Documentação XML (Visual C++)
No Visual C++, você pode adicionar comentários ao código-fonte que são processados em um arquivo de documentação XML. Em seguida, esse arquivo pode ser a entrada para um processo que cria a documentação para as classes no código.
Em um arquivo de código do Visual C++, os comentários da documentação XML precisam estar localizados diretamente antes de uma definição de método ou de tipo. Os comentários podem ser usados para popular a dica de dados QuickInfo do IntelliSense nos seguintes cenários:
Quando o código é compilado como um componente do Windows Runtime com um arquivo WINMD
Quando o código-fonte é incluído no projeto atual
Em uma biblioteca cujas declarações de tipo e implementações estão localizadas no mesmo arquivo de cabeçalho
Observação
Na versão atual, os comentários sobre código não são processados em modelos nem em nenhum item que contenha um tipo de modelo (por exemplo, uma função que usa um parâmetro como modelo). A adição desses comentários resultará em um comportamento indefinido.
Para obter detalhes sobre como criar um arquivo XML com comentários da documentação, confira os artigos a seguir.
| Para obter informações sobre | Consulte |
|---|---|
| As opções do compilador a serem usadas | /doc |
| As marcas que podem ser usadas para fornecer as funcionalidade geralmente usadas na documentação | Tags recomendadas para comentários de documentação |
| As cadeias de identificação produzidas pelo compilador para identificar os constructos no código | Processando o Arquivo XML |
| Como delimitar as marcas da documentação | Delimitadores de marcas de documentação para o Visual C++ |
| Gerando um arquivo XML com base em um ou mais arquivos XDC. | Referência do XDCMake |
| Links para informações sobre XML relacionado às áreas de recursos do Visual Studio | XML no Visual Studio |
Caso precise colocar caracteres especiais XML no texto de um comentário da documentação, use entidades XML ou uma seção CDATA.