Compartilhar via


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

Faz o compilador a comentários de documentação do processo em arquivos de código-fonte e criar um arquivo de .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á.Válido somente quando um arquivo. cpp é passado a 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 de XDCMake.

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

/docnão é compatível com /clr:oldSyntax.Consulte /CLR (common Language Runtime Compilation) para obter mais informações.

Para usar o arquivo. XML gerado com IntelliSense, verifique o nome do 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, também é localizar o arquivo. XML.Para obter mais informações, consulte Usando IntelliSense e Fornecendo comentários de código XML.

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

  1. Abra o projeto Páginas de propriedades caixa de diálogo.Para obter detalhes, consulte:Como: abrir páginas de propriedades do projeto.

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

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

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

  5. Modificar o Gerar arquivos de documentação XML propriedade.

Para definir esta opção de vinculador programaticamente

Consulte também

Referência

Opções do compilador

Configurando opções de compilador