c# - 如何在 XML Comment 注释中指定类型

Question

在我的 C# XML 评论中 <return>评论，我希望输出(我正在使用 SandcaSTLe)指定返回的类型，但我无法找到如何做到这一点。

伪示例:

///<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() 文档的屏幕截图显示我正在拍摄的返回类型的方法。

我们是否必须手动指定类型，或者我们是否可以指定一个类型(类似于模拟示例)并让 SandcaSTLe 确定如何显示/格式化输出 - 类似于 SandcaSTLe 如何通过自动显示/格式化参数的类型<param>标签。

Answer 1

您不需要在 XML 文档中指定它 - 毕竟，如果它在方法声明中，那将是多余的。

我怀疑如果您确实需要，可以调整 SandcaSTLe 样式 - 但您觉得它特别有用吗？这不像用户不能只单击方法签名中的返回类型。 (至少 SHFB 中的原型(prototype)样式似乎就是这种情况。请参阅 Noda Time documentation 以了解其外观的示例。)

在 MSDN 中，方法签名没有有链接(至少在 Chrome 中没有；我不知道它在 IE 中是否不同)但我个人更希望它在签名中而不是使实际文档困惑。