Cómo especificar el tipo en un comentario XML <return> comentario

Question

En mi comentario de C# XML <return> comentario, me gustaría el resultado (estoy usando Sandcastle) para especificar el tipo que se devuelve, pero no puedo averiguar cómo Para hacer eso.

Psuedo Ejemplo:

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

El ejemplo anterior es una maqueta de lo que yo creo que es para contar castillo de arena de cómo especificar el tipo de retorno que se documenta en la sección Syntax de la documentación - no es así.

Para mayor claridad, aquí hay una captura de pantalla de la documentación de MSDN del método GetHastCode() que muestra el tipo de retorno que estoy filmando.

Tenemos que especificar manualmente el Tipo, o podemos especificar un Tipo (similar al ejemplo simulado) y dejar que Sandcastle determine cómo mostrar/formatear la salida, similar a cómo Sandcastle muestra/formatea automáticamente el Tipo para parámetros a través de la etiqueta <param>.

Answer 1

This post (julio de 2011) tiene una respuesta de Eric Woodruff (SHFB Autor) con respecto a la falta de rentabilidad del tipo que se muestra en la etiqueta de <return>:

castillo de arena no hace que la información de tipo para el regreso información y no creo que alguna vez lo haya hecho. Si la información es en el archivo de información de reflexión, las transformaciones XSL podrían ser modificadas para representarlo. No tengo tiempo para analizarlo ahora, pero puede ser capaz de en algún momento averiguar si es posible.

Supongo que la respuesta oficial a mi OP es; Sandcastle no tiene una forma automática de especificar el Tipo devuelto, pero, como se mencionó anteriormente con Skeet, puede ser posible lograr esto modificando las transformaciones XSL.

Answer 2

No debería ser necesario que lo especifique en la documentación XML - después de todo, que sería redundante, dado que es en la declaración del método.

Sospecho que es cuestión de retocar el estilo de Sandcastle si realmente lo quiere, pero ¿le parece particularmente útil? No es como si los usuarios no pudieran simplemente hacer clic en el tipo de devolución en la firma del método. (Al menos eso es lo que parece ser el caso para el estilo del prototipo en SHFB. Ver la Noda Time documentation para un ejemplo de lo que parece.)

En MSDN, entonces el método de firma qué no tienen enlaces (al menos no en Chrome, no sé si es diferente en IE) pero personalmente preferiría que estuviera en la firma en lugar de de llenar la documentación real.