Cómo especificar el tipo en un comentario XML comentario

Question

En el comentario <return> de mi comentario XML de C #, me gustaría que la salida (estoy usando Sandcastle) especifique el tipo que se devuelve, pero no puedo averiguar cómo hacerlo.

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

El ejemplo anterior es una simulación de lo que supongo que es decirle a Sandcastle cómo especificar el tipo de retorno que está documentado 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 de GetHastCode () método que muestra el tipo de retorno que estoy buscando.

¿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 los parámetros a través de la etiqueta <param>.

Answer 1

Esta publicación (julio de 2011) tiene una respuesta de Eric Woodruff (autor de SHFB) sobre la falta del tipo de retorno que se muestra dentro de la etiqueta <return>:

Sandcastle no muestra la información de tipo para la devolución información y no creo que nunca lo haya hecho.Siempre que la información sea en el archivo de información de reflexión, las transformaciones XSL podrían ser modificado para renderizarlo.No tengo tiempo para investigarlo ahora, pero puede que ser capaz en algún momento de averiguar si es posible.

Supongo que la respuesta oficial a mi OP es;Sandcastle no tiene una forma automática de especificar el tipo de retorno, pero, como ya mencionó Skeet, puede ser posible lograrlo modificando las transformaciones XSL.

Answer 2

No debería necesitar especificarlo en la documentación XML; después de todo, eso sería redundante, dado que está en la declaración del método.

Sospecho que se trata de modificar el estilo del castillo de arena si realmente lo desea, pero ¿lo encuentra particularmente útil?No es que los usuarios no puedan simplemente hacer clic en el tipo de retorno en la firma del método.(Al menos ese parece ser el caso del estilo Prototype en SHFB. Consulte Documentación de Noda Time para ver un ejemplo de cómo se ve).

En MSDN, la firma del método no tiene 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 abarrotar la documentación real.