Compartilhar via


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

Faz com que o compilador aos comentários sobre a documentação do processo em arquivos de origem e criar um arquivo de .xdc para cada arquivo de origem que tem comentários sobre a documentação.

/doc[name]

Arguments

  • name
    O nome do arquivo de .xdc que o compilador criará. Válido apenas quando um arquivo .cpp é transmitido na compilação.

Comentários

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

Você pode adicionar comentários sobre a documentação ao seu arquivo de código-fonte. Para obter mais informações, consulte Marcas recomendadas para comentários da documentação (Visual C++).

/doc não é compatível com /clr:oldSyntax. Consulte /clr (compilação do Common Language Runtime) para maiores informações.

Para usar o arquivo .xml gerado com IntelliSense, faça o nome do arquivo .xml o mesmo que o assembly que você deseja dar suporte a e colocar o arquivo .xml estiver no mesmo diretório que o assembly. Quando o assembly for referenciado no projeto do Visual Studio, o arquivo .xml também está localizado. Para obter mais informações, consulte Usando IntelliSense e Fornecendo 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 Propriedade do projeto. Para obter detalhes, consulte Como abrir páginas de propriedade do projeto.

  2. Expanda o nó Propriedades de Configuração.

  3. Expanda o nó de C/C++ .

  4. Selecione a página de propriedades de ARQUIVOS DE SAÍDA .

  5. Modifique a propriedade de Gera Arquivos XML de Documentação .

Para definir essa opção de vinculador por meio de programação

Consulte também

Referência

Opções do compilador

Definindo opções do compilador