Partilhar via


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

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

/doc[name]

Argumentos

  • name
    O nome do arquivo .xdc que o compilador criará.Só é válido quando um arquivo .cpp é passado a compilação.

Comentários

Os arquivos .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 de documentação a seus arquivos de código-fonte.Para obter mais informações, consulte Tags recommended for Comentários Documentação (Visual C++).

/doc não é compatível com /clr:oldSyntax. Consulte /CLR (Common linguagem tempo de execução compilação) para obter mais informações.

Para usar o arquivo .xml gerado com o IntelliSense, verifique o nome de arquivo do arquivo .xml, o mesmo que o assembly que você deseja oferecer suporte e colocar o arquivo .xml está no mesmo diretório do assembly.Quando o assembly é referenciado no projeto Visual Studio, o arquivo .xml também está localizado.Para obter mais informações, consulte Usando o IntelliSense e Fornecer comentários de código XML.

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

  1. em aberto propriedade Páginas caixa de diálogo.Para obter detalhes, consulte:Como: Abrir o Projeto Propriedade Páginas.

  2. expandir o Propriedades de configuração nó.

  3. expandir o C/C++ nó.

  4. selecionar o Arquivos de saída página de propriedades.

  5. Modificar o Gerar arquivos de documentação XMLpropriedade .

Para conjunto esta opção de vinculador programaticamente

Consulte também

Referência

Opções do compilador

Opções de compilador configuração