/doc (Processar comentários de documentação) (C/C++)

  • Artigo

Faz com que o compilador processe comentários da documentação em arquivos de código-fonte e crie um arquivo .xdc para cada arquivo de código-fonte que tenha comentários da documentação.

Sintaxe

/doc[name]

Argumentos

name
O nome do arquivo .xdc que o compilador criará. Válido somente quando um arquivo .cpp é passado na compilação.

Comentários

Os arquivos .xdc são processados em um arquivo .xml com o xdcmake.exe. Para obter mais informações, confira Referência do XDCMake.

Você pode adicionar comentários de documentação aos seus arquivos de código-fonte. Para obter mais informações, confira Marcas recomendadas para comentários da documentação.

Para usar o arquivo .xml gerado com o IntelliSense, deixe o nome do arquivo .xml igual ao do assembly a que você deseja dar suporte e coloque o arquivo .xml no mesmo diretório que o assembly. Quando o assembly for referenciado no projeto do Visual Studio, o arquivo .xml também será encontrado. Para obter mais informações, confira Usar o IntelliSense e Fornecer comentários de código XML.

Para definir esta opção do compilador no ambiente de desenvolvimento do Visual Studio

  1. Abra a caixa de diálogo Páginas de Propriedades do projeto. Para obter detalhes, confira Definir as propriedades de build e do compilador do C++ no Visual Studio.

  2. Selecione a página de propriedades Propriedades da Configuração>C/C++>Arquivos de Saída.

  3. Modifique a propriedade Gerar Arquivos de Documentação XML.

Para definir esta opção do vinculador por meio de programação

Confira também

Opções do compilador MSVC
Sintaxe da linha de comando do compilador MSVC