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.Come specificare il tipo in un commento XML <return> commento
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>
.
Tuttavia, per rendere la parola "Oggetto" un riferimento al tipo pertinente, è necessario scrivere: '/// Un codice hash per la corrente .' –
Mi piacerebbe lo so anche io, ho un'API che usa 'JsonResult' ma T è un tipo anonimo. In ogni modo, cerco di specificare errori di tipo diverso da quelli dinamici. –
Andrew