如何在XML Comment <return> comment </return>中指定Type

Question

在我的C＃XML Comment <return>评论中，我希望输出（我使用Sandcastle）指定返回的Type，但我无法找到如何做到这一点。

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

上面的示例模拟了我的猜测，告诉Sandcastle如何指定文档的Syntax部分中记录的返回类型 - 不是这样。

为清楚起见，这里是MSDN的GetHastCode()方法文档的屏幕截图，显示了我正在拍摄的返回类型。

我们是否必须手动指定Type，或者我们是否可以指定Type（类似于mock示例）并让Sandcastle确定如何显示/格式化输出 - 类似于Sandcastle如何自动显示/格式化参数的类型<param>代码。

Answer 1

你不应该在XML文档中指定它 - 毕竟，这是多余的，因为它在方法声明中。

我怀疑这是一个调整Sandcastle风格的问题，如果你真的想要它 - 但你觉得它特别有用吗？用户不能只是单击方法签名中的返回类型。 （至少对于SHFB中的原型样式来说就是这种情况。请参阅Noda Time documentation了解一下这样的例子。）

在MSDN中，方法签名不有链接（至少不在Chrome中;我不知道它在IE中是否有所不同）但我个人更希望它在签名中反而混乱了实际的文档。

Answer 2

This post（2011年7月）得到了Eric Woodruff（SHFB作者）关于<return>标签中缺少返回类型的回复：

  

Sandcastle不会呈现返回的类型信息   信息，我认为它没有。提供的信息是   在反射信息文件中，XSL转换可以是   修改为渲染它。我现在没有时间研究它，但可能   能够在某个时候找出它是否可能。

我想我的OP的官方答案是; Sandcastle没有自动指定返回类型的方法，但是像Skeet已经提到的那样， 可能 可以通过修改XSL转换来实现这一点。