Pergunta

Como ativar/obter comentários XML para métodos C++ como C# e VB no Visual Studio 2010?Parece que esta funcionalidade não está habilitada/disponível por padrão.

Visando projetos C++ inicialmente gerenciados.

Foi útil?

Solução

Isso não é suportado no C ++ para o VS2010.

Outras dicas

Propriedades de configuração -> c/c ++ -> arquivos de saída -> gerar arquivos de documentação XML.

Você precisará adicionar manualmente toda a sua documentação XML (/// não criar automaticamente um modelo de resumo para você). Também não suporta o Paramref. http://msdn.microsoft.com/en-us/library/ms173501.aspx

Para completar automaticamente os stubs de documentação xml quando /// é digitado, tente CppTripleSlash - comentários do documento xml para c++ extensão.Ele também possui algum senso básico para preencher tags xml dentro de comentários de documentos.

Sei que este é o antigo, mas em todos os lugares que eu olhei para todos dizer que não é suportado, precisam de ferramenta de terceiros ou similar, que não é o verdadeiro. O que você precisa saber é que a documentação XML é suportada e está disponível no Visual Studio 2010, e há apenas duas coisas a saber sobre isso:

  1. Docs / versões anteriores / Visual Studio / XML Documentation / Tags recomendados para comentários de documentação:https://docs.microsoft.com/en-us/previous-versions/visualstudio/visual-studio-2012/ms177227%28v%3DVs.90%29

  2. Em "C ++ Project Properties / C / C ++ / Saída Arquivos / Gere Arquivos de Documentação XML" Definir como "Yes ( / Doc)"

Ele gerará o arquivo .xdc para cada arquivo de origem que contém comentários de documentação "///" e mesclará um arquivo de documentação .xml. E a documentação funciona muito bem mais tarde em outros projetos.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top