Come specificare il tipo in un commento XML <return> commento

Question

Nel commento del commento XML C# <return> nel mio C#, vorrei l'output (sto usando Sandcastle) per specificare il Tipo restituito, ma non riesco a scoprire come fare quello.

Psuedo Esempio:

///<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(){...} 

L'esempio precedente è una finta di ciò che la mia ipotesi è di dire Sandcastle come specificare il tipo di ritorno che è documentata nella sezione Syntax della documentazione - non è così.

Per chiarezza, ecco uno screenshot della documentazione di MSDN del metodo GetHastCode() che mostra il tipo di reso per il quale sto girando.

Dobbiamo specificare manualmente il Tipo, oppure possiamo specificare un Tipo (simile all'esempio di simulazione) e lasciare Sandcastle determinare come visualizzare/formattare l'output - simile a come Sandcastle visualizza/formatta automaticamente il Tipo per i parametri tramite il tag <param>.

Answer 1

This post (luglio 2011) ha una risposta da Eric Woodruff (SHFB Autore) per quanto riguarda la mancanza del tipo di ritorno di essere visualizzati all'interno della <return> tag:

Sandcastle non rende le informazioni sul tipo per il ritorno informazioni e non credo che abbia mai avuto. Se le informazioni sono nel file di informazioni di riflessione, le trasformazioni XSL potrebbero essere modificate per il rendering. Non ho il tempo di esaminarlo ora, ma posso essere in grado di scoprire se è possibile.

Suppongo che la risposta ufficiale al mio OP sia; Sandcastle non ha un modo automatico per specificare il tipo di ritorno ma, come già accennato a Skeet, è possibile effettuare modificando le trasformazioni XSL.

Answer 2

Non dovrebbe essere necessario specificarlo nella documentazione XML - dopo tutto, che sarebbe superfluo, dato che è nella dichiarazione di metodo.

Sospetto che si tratti di modificare lo stile Sandcastle se lo si desidera veramente, ma lo si ritiene particolarmente utile? Non è che gli utenti non possono semplicemente fare clic sul tipo restituito nella firma del metodo. (Almeno questo è quello che sembra essere il caso per lo stile del prototipo in SHFB. Vedere la Noda Time documentation per un esempio di quello che sembra.)

In MSDN, quindi firma del metodo non fa hanno legami (almeno non in Chrome, non so se è diverso in IE) ma personalmente preferirei che fosse nella firma invece di ingombrare la documentazione effettiva.