如何在XML注释注释中指定类型

Question

在我的C＃XML Comment的<return>注释中，我希望输出（我正在使用Sandcastle）指定要返回的Type，但是我无法找到执行该操作的方法。

伪示例： 通用标签

上面的示例是我的猜测的一个模拟，它告诉Sandcastle如何指定文档的Syntax部分中记录的返回类型-并非如此。

为清楚起见，这是 GetHastCode（）方法，显示我要拍摄的返回类型。

我们是否必须手动指定类型，还是可以指定类型（类似于模拟示例），然后让Sandcastle确定如何显示/格式化输出-类似于Sandcastle通过以下方式自动显示/格式化参数类型的方法<param>标签。

Answer 1

这篇文章（2011年7月）收到了来自Eric Woodruff（SHFB作者）的回复，内容是在<return>标签内缺少返回类型的显示：

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

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

Answer 2

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

我怀疑，如果您确实需要，可以调整Sandcastle样式-但是您发现它特别有用吗？并不是用户不能只单击方法签名中的返回类型。（至少SHFB中的原型样式似乎是如此。请参见 Noda Time文档，以获取外观示例。）

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