Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/ruby-on-rails-3/4.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
C# 如何在XML注释中指定类型<;回报>;评论_C#_Sandcastle_Xml Comments - Fatal编程技术网

C# 如何在XML注释中指定类型<;回报>;评论

C# 如何在XML注释中指定类型<;回报>;评论,c#,sandcastle,xml-comments,C#,Sandcastle,Xml Comments,在我的C#XML注释的注释中,我希望输出(我使用的是Sandcastle)指定返回的类型,但我无法找到如何执行该操作 Psuedo示例: ///<summary> ///Serves as a hash function for a particular type. ///</summary> ///<returns **Type="System.Int32"**> ///A hash code for the current Object. ///</

在我的C#XML注释的
注释中,我希望输出(我使用的是Sandcastle)指定返回的类型,但我无法找到如何执行该操作

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(){...}
///
///用作特定类型的哈希函数。
///
///
///当前对象的哈希代码。
///
公共虚拟int GetHashCode(){…}
上面的示例模拟了我的猜测,告诉Sandcastle如何指定文档中
语法
部分中记录的返回类型,但事实并非如此

为清楚起见,这里是MSDN的方法文档截图,显示了我拍摄的返回类型

我们是否必须手动指定类型,或者我们是否可以指定类型(类似于模拟示例)并让Sandcastle确定如何显示/格式化输出-类似于Sandcastle如何通过
标记自动显示/格式化参数的类型


您不需要在XML文档中指定它——毕竟,这是多余的,因为它在方法声明中

如果你真的想要的话,我怀疑这是一个调整Sandcastle风格的问题——但是你觉得它特别有用吗?用户不能只单击方法签名中的返回类型。(至少SHFB中的原型样式似乎是这样的。请参阅以获取其外观的示例。)

在MSDN中,则方法签名没有链接(至少在Chrome中没有;我不知道它在IE中是否不同),但就个人而言,我更希望它出现在签名中,而不是把实际文档弄得乱七八糟。

(2011年7月)Eric Woodruff(SHFB作者)对此有回应关于
标记中显示的返回类型的缺失:

Sandcastle不会呈现返回的类型信息 信息,我认为从来没有。如果信息是 在反射信息文件中,XSL转换可以是 修改以渲染它。我现在没有时间调查,但梅 能够在某个时刻发现它是否可能


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

我听说您@redundant。我的观点是,由于MSDN/Sandcastle在Parameters部分中冗余地指定了类型,因此我假设有一种内置的方法来指定返回值的类型。但是,为了使“Object”一词成为对相关类型的引用,您需要编写:
///当前的哈希代码。
我也想知道这一点,我有一个使用
JsonResult
的API,但T是匿名类型。我尝试指定除dynamic以外的类型的每一种方法都会出错。