Web API 2 帮助页面是不是没有处理 XML 文档标签？

Posted 2023-04-13

【中文标题】Web API 2 帮助页面是不是没有处理 XML 文档标签？

【英文标题】：Are XML documentation tags not being handled by Web API 2 help pages?Web API 2 帮助页面是否没有处理 XML 文档标签？

【发布时间】：2014-05-24 00:02:03

【问题描述】：

我正在尝试在我的 API 的 XML 文档标签中使用 <see cref=""> 标签，但它们在帮助页面中显示为空白。

所以，我想说的是：

"获取或设置关联Item的值。"

Item 是指向 API 中另一个对象的链接。

相反，我得到：

“获取或设置关联的值。”

所以<see cref=""> 标签被忽略了。我什至尝试使用来自here 的示例，以防我的声明有误，但这也不起作用。

还有其他人对此有疑问吗？新的 Web API 2 帮助页面对 XML 文档标签的支持程度如何？有谁知道是否可以手动添加对此的支持？

【问题讨论】：

我们确实有同样的问题，但是所有围绕这个主题的博文似乎都已经过时了。

我在***.com/questions/26177104/…概述了这样做的方法

【参考方案1】：

我没有遇到过这个问题，但我建议你

发布一个简单的示例来说明行为以及您获得的结果

检查可能表明您的 XML 文档标签存在问题的构建警告。

例如，您说您正在使用<see cref=""> 您是否在 cref 属性中放置了一个有效的标识符并关闭了 see 标记 - 例如<see cref="MyClass.MyMethod" />?

【讨论】：

嘿乔，我们有同样的问题，似乎其他人也看到了这个问题。如果您对从哪里开始有任何提示？