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

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

/doc[name]

Arguments

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

Comentários

Os arquivos de .xdc são processados em um arquivo. XML com xdcmake.exe. For more information, see XDCMake Reference.

Você pode adicionar comentários de documentação para seus arquivos de código-fonte. For more information, see Recommended Tags for Documentation Comments (Visual C++).

/docnão é compatível com /clr:oldSyntax. See /CLR (common Language Runtime Compilation) for more information.

Para usar o arquivo. XML de gerado com o IntelliSense, verifique o nome de arquivo do arquivo. XML, o mesmo 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 se encontra. For more information, see Usando o IntelliSense and Fornecendo comentários de código XML.

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

  1. Abra o projeto Property Pages caixa de diálogo. For details, see 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

Definindo opções do compilador