Como especificar o tipo em um comentário XML comentário

Question

No comentário <return> do meu comentário C # XML, gostaria que a saída (estou usando o Sandcastle) especificasse o tipo que é retornado, mas não consigo descobrir como fazer isso.

Exemplo de Psuedo:

///<summary>
///Serves as a hash function for a particular type.
///</summary>
///<returns **Type="System.Int32"**>
///A hash code for the current Object.
///</returns>
public virtual int GetHashCode(){...}

O exemplo acima é uma simulação do que suponho dizer ao Sandcastle como especificar o tipo de retorno documentado na seção Syntax da documentação - não é assim.

Para maior clareza, aqui está uma captura de tela da documentação do MSDN do GetHastCode () método que mostra o tipo de retorno que estou buscando.

Precisamos especificar manualmente o tipo ou podemos especificar um tipo (semelhante ao exemplo simulado) e deixar o Sandcastle determinar como exibir / formatar a saída - semelhante a como o Sandcastle exibe / formata automaticamente o tipo para os parâmetros via a tag <param>.

Answer 1

Esta postagem (julho de 2011) tem uma resposta de Eric Woodruff (Autor SHFB) sobre a falta do tipo de retorno que está sendo exibido na tag <return>:

Sandcastle não processa as informações de tipo para o retorno informações e eu acho que nunca.Desde que a informação seja no arquivo de informação de reflexão, as transformações XSL podem ser modificado para renderizá-lo.Eu não tenho tempo para olhar para isso agora, mas posso ser capaz de em algum momento descobrir se é possível.

Suponho que a resposta oficial ao meu OP seja;O Sandcastle não tem uma maneira automática de especificar o tipo de retorno, mas, como Skeet já aludiu, pode ser possível fazer isso modificando as transformações XSL.

Answer 2

Você não deve precisar especificá-lo na documentação XML - afinal, isso seria redundante, visto que está na declaração do método.

Suspeito que seja uma questão de ajustar o estilo do Sandcastle se você realmente quiser - mas você o considera particularmente útil?Não é como se os usuários não pudessem simplesmente clicar no tipo de retorno na assinatura do método.(Pelo menos é o que parece ser o caso para o estilo Prototype em SHFB. Veja o Documentação da Noda Time para ver um exemplo de como é.)

No MSDN, a assinatura do método não tem links (pelo menos não no Chrome; não sei se é diferente no IE), mas pessoalmente prefiro que esteja na assinatura em vez de bagunçar a documentação real.