如何在XML注释中指定类型<return>评论

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

的伪例：

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

上面的例子是我的猜测是，告诉沙堡怎样来指定记录在文档中的Syntax部分的返回类型是什么一个模拟 - 并非如此。

为了清楚起见，这里是GetHastCode()方法表明，我拍摄的返回类型的MSDN文档的截图。

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

enter image description here

来源

2012-02-21 Jed

但是，要使“对象”这个单词成为相关类型的引用，您需要编写如下代码：'///当前<参阅cref =“Object”/>的哈希代码。' – 2016-09-14 12:54:31

我想也知道这一点，我有一个使用'JsonResult '的API，但T是一个匿名类型。我试图指定除动态运行以外的其他类型的错误。 – Andrew 2017-02-10 17:00:02

This post（2011年7月），有来自埃里克·伍德拉夫（SHFB作者）对缺乏返回类型的响应<return>标签中显示：

沙堡没有渲染的返回类型信息信息，我不认为它曾经有过。如果反射信息文件中的信息是，则XSL转换可以被修改为以呈现它。我现在没有时间查看它，但可能在某些时候发现它是否可能。

我想官方回答我的OP是;沙堡没有指定返回类型的自动方式，但是，像斯基特已经暗示，它可能可以通过修改XSL转换来实现这一目标。

来源

2012-02-24 22:38:20 Jed

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

我怀疑这是调整的沙堡风格的，如果你真的想一个问题 - 但是你觉得特别有用吗？这不像用户不能单击方法签名中的返回类型。（至少，这似乎是在SHFB原型风格的情况下。见Noda Time documentation为看上去是什么样的例子。）

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

来源

2012-02-21 23:40:02

我听到你@多余。我从MSDN/Sandcastle冗余地指定参数部分中的类型的角度出发，我认为还有一种内置的方式来为返回值指定类型。 – Jed 2012-02-22 00:00:21

如何在XML注释中指定类型<return>评论

回答

相关问题