Quadro goto definição mostra comentários, estes são gerados a partir de xml comentários?

Question

Eu estava levemente surpreso recentemente para descobrir que meu cuidadosamente trabalhada xml comentários não estavam aparecendo no intellisense para os meus colegas.Tendo sempre usei os assemblies associadas com referências de projeto, eu não tinha percebido que você tinha para exportar .documento xml, bem como para aceder a esta informação.

Isto levou-me a pensar como as .Net framework intellisense funciona.Se eu entendi corretamente, o .os arquivos xml devem ser escondido em algum lugar em uma pasta especial?

Mas a minha principal questão é sobre 'Goto definição' - se você goto definição em um .Net framework assembly, você obter as informações geradas a partir dos metadados, mas também com abundância de comentários, estes são magicamente gerado a partir de Xml comentários, ou alguém tem que escrever uma macro + para convertê-los apenas para a compilação?Colocando de forma diferente:como posso obter este efeito para minhas montagens?

Answer 1

São seus projetos configurado para gerar o XML de documentação?Só porque você adicione comentários ao código-fonte, o compilador não irá gerar o .arquivo xml, a menos que seja instruído para tal.

Na página de propriedades do projeto, vá para a "Construir" e olhar para a "Saída" seção.Você deverá ver uma caixa de seleção de entrada intitulado "arquivo de documentação XML".Se a caixa de texto seguinte a caixa de verificação estiver vazio, você não estão gerando o arquivo de documentação XML.

Depois de obter o arquivo de documentação XML gerado, você deve ver os seus comentários na IntelliSense dicas de ferramentas.Se você incluir referências a outros projetos, como um projecto de referência, isso deve acontecer automaticamente.Se você incluir referências aos assemblies, você precisa garantir que o arquivo xml é no mesmo local do assembly referenciado.(Quando você criar, você deve obter arquivos xml para todos os conjuntos que tê-los na bin/debug ou bin/pasta de versão, respectivamente.)

Para .NET Framework conjuntos si, o xml correspondente documentação de arquivos são instalados como parte do Framework.Para .NET 2.0, 3.0 ou 3.5 a documentação de arquivos estão localizados em C:\Windows\Microsoft.NET\Framework\v2.0.50727\en (supondo uma instalação padrão do Framework).Esses arquivos são usados por ambos, o IntelliSense dicas de ferramentas e o "Vá para a Definição de" funcionalidade no Visual Studio, a fim de apresentar esta informação.Não há qualquer processamento especial que tem lugar, ou macros de execução, a fim de fazer isso acontecer.A única informação Visual Studio provavelmente usa é uma combinação de chaves de registo para determinar o caminho correto para os arquivos de documentação.

Enquanto você provavelmente pode localizar os arquivos de documentação xml para as suas próprias montagens na mesma pasta, eu recomendaria fazer como você, em seguida, poluir o Quadro de instalação com o não-Enquadramento arquivos relacionados.