如何在XML 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>标记自动显示/格式化参数的Type .

Answer 1

您不需要在 XML 文档中指定它 - 毕竟，鉴于它位于方法声明中，这将是多余的。

我怀疑如果你真的想要的话，需要调整沙堡风格 - 但你觉得它特别有用吗？这并不是说用户不能只单击方法签名中的返回类型。（至少 SHFB 中的原型样式似乎是这样。有关其外观的示例，请参阅Noda Time 文档。）

在 MSDN 中，方法签名没有链接（至少在 Chrome 中没有；我不知道在 IE 中是否不同），但我个人更希望它出现在签名中，而不是弄乱实际的文档。

Answer 2

这篇文章（2011 年 7 月）有来自 Eric Woodruff（SHFB 作者）关于标签内缺少返回类型显示的回复<return>：

Sandcastle 不会渲染返回信息的类型信息，我认为它从来没有渲染过。如果信息位于反射信息文件中，则可以修改 XSL 转换来呈现它。我现在没有时间研究它，但也许在某个时候可以找出它是否可能。

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