É possível incluir um link para um site na documentação XML? Por exemplo, meu método está resumido em
///<Summary>
/// This is a math function I found HERE.
///</Summary>
public void SomeMathThing(Double[] doubleArray)
{
...
}
e quando eu digito
SomeMathThing(
Quero que o IntelliSense mostre o resumo com a opção de clicar em "AQUI" para criar um link para um site externo. Isso é possível? Como isso seria feito?
href
atributo.Um pouco tarde no hype-train, mas aqui está o que eu descobri para o Visual Studio 2015.
Minha amostra é assim:
Os resultados são:
Conclusão: O melhor, como Heiner apontou, seria
Atualização Como Thomas Hagström apontou, o Resharper agora suporta URLs a-href clicáveis. Captura de tela atualizada de acordo.
fonte
Você pode usar a sintaxe HTML padrão:
O texto será exibido no Visual Studio.
fonte
Você pode incluir um prefixo!: Em um cref para que ele passe intocado na documentação XML gerada, para que ferramentas como o Innovasys Document! X e Sandcastle o usarão. por exemplo
O intellisense do Visual Studio não exibirá isso como um link para o intellisense - não faria muito sentido, pois é uma dica de ferramenta, portanto você não pode clicar nela de qualquer maneira.
fonte
<see/>
URIs de sites clicáveis e reconhecidos de alguma forma (já que o Pesquisador de objetos não é uma dica de ferramenta). Apenas dizendo' ;-).Use uma etiqueta. Por exemplo, eu usei esta solução no meu projeto
O resultado está aqui
Meu código xml é:
Ou use a tag "ver". O resultado é o mesmo da tag "a"
fonte