Como fazer um CREF para sobrecargas do método em uma tag em C #?

Question

Eu vejo em ligações MSDN como "CompareOrdinal sobrecargas". Como posso escrever essa ligação uma em C #?

Eu tentei:

<seealso cref="MyMethod">MyMethod Overloads</seealso>

Mas o compilador me dá um aviso sobre ser uma referência ambígua para o método que tem outras sobrecargas.

(pergunta Iniciante:? Eu realmente precisa escrever essa tag para link para as sobrecargas, ou é automaticamente gerada pelos processadores de documentação)

Answer 1

documentação

XML não tem um meio de referência Todas as sobrecargas de um método.

O gerador de documentação populares mais para projetos de C # é Sandcastle. Ele vai criar automaticamente um link para uma página da lista de sobrecargas, se necessário. Daí em uma página da lista de membros o nome de um método sobrecarregado irá aparecer apenas uma vez, clicando nele irá conduzi-lo à lista de página de sobrecargas para esse método e de lá para uma sobrecarga específica.

Colocar um link para a página da lista de sobrecargas na documentação Xml exigiria conhecimento íntimo da ferramenta externa que está sendo usado e, provavelmente, não é uma boa idéia.

Se você realmente deve ter isso, então talvez uma maneira é usar uma âncora com um ID specificaly formado. A maioria dos geradores de documentos fornecer alguns meios arcanos de arquivos de processamento gerado pré ou pós e deve dar-lhe a oportunidade de escolher essas âncoras fora e fornecer um href apropriado para eles.

OTH, pode ser mais problemas do que vale a pena;)

Answer 2

Para alvo específica membros, eu acredito que você só corresponde à assinatura:

/// <seealso cref="Foo(int)"/>
static void Foo() { }
/// <seealso cref="Foo()"/>
/// <seealso cref="Foo(float)"/> <------ complains
static void Foo(int a) { }

Para ser honesto, eu não sei como para gerar um link "todas as sobrecargas"; Eu supor que qualquer gerador sensata fez isso automaticamente.

Answer 3

Usando Sandcastle é simples:

<seealso cref="overloads:FullyQualifiedMyMethod">MyMethod Overloads</seealso>

FullyQualifiedMyMethod é a rota completa você precisa para alcançar a sobrecarga, incluindo namespaces e classes, i .: System.Linq.Enumerable.Sum

No entanto questões VB compilador um aviso dizendo que o atributo não podem ser resolvidos, que podem ser ignorados.