Come specificare il tipo in un commento XML commento

Question

Nel commento <return> del mio commento XML C #, vorrei che l'output (sto usando Sandcastle) specifichi il tipo restituito, ma non sono in grado di scoprire come farlo.

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

L'esempio sopra è una simulazione di quello che penso sia dire a Sandcastle come specificare il tipo di ritorno che è documentato nella sezione Syntax della documentazione - non così.

Per chiarezza, ecco uno screenshot della documentazione MSDN di GetHastCode () che mostra il tipo di ritorno per cui sto scattando.

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

Answer 1

Questo post (luglio 2011) ha una risposta da Eric Woodruff (SHFB Author) in merito alla mancanza del tipo di ritorno visualizzato all'interno del tag <return>:

Sandcastle non restituisce le informazioni sul tipo per il ritorno informazioni e non credo che lo abbia mai fatto.A condizione che le informazioni siano nel file di informazioni di riflessione, le trasformazioni XSL potrebbero essere modificato per renderlo.Non ho tempo per esaminarlo ora, ma potrebbe essere in grado a un certo punto 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 Skeet già accennato, è può essere possibile farlo modificando le trasformazioni XSL.

Answer 2

Non dovresti aver bisogno di specificarlo nella documentazione XML - dopotutto, sarebbe ridondante, dato che è nella dichiarazione del metodo.

Sospetto che sia questione di modificare lo stile Sandcastle se lo vuoi davvero, ma lo trovi particolarmente utile?Non è che gli utenti non possano semplicemente fare clic sul tipo di ritorno nella firma del metodo.(Almeno questo è ciò che sembra essere il caso dello stile Prototype in SHFB. Vedi Documentazione Noda Time per un esempio di come appare.)

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