如何使Visual Studio智能感知显示XML注释中的备注部分？

Question

当编写代码时，我非常喜欢Visual Studio 2010（专业版）的Intellisense功能，特别是能够查看正在使用的类型的XML注释。 （请参阅Microsoft的文档）。到目前为止，这个功能还可以使用。 然而，XML代码注释的备注部分未显示。

我认为这是一个非常有用的功能，因为通常有一些有用的信息无法从摘要中轻松推测出来。（这就是为什么我们有备注部分的原因）

如何在Visual Studio 2010（专业版）的Intellisense级别上探索备注部分？（我使用DevXpress Coderush，但我认为不需要考虑这个）。

- Marcel

---

这可能会产生笨重的 IntelliSense 工具提示。<remarks> 部分不打算从 IntelliSense 中显示，而是包含不需要立即掌握的信息。您可以从对象浏览器或自动生成的 XML 注释文档中阅读备注。 - Cody Gray

@CodyGray：是啊，但我得在对象浏览器窗口中搜索类型。这太烦人了，考虑到我已经在代码中“确定”了我想要获取信息的类型。或者我是否忽略了对象浏览器中的“跟踪光标上的类型”之类的功能？ - Marcel

F12 键会自动显示所选对象的源代码（如果有），或将其显示在对象浏览器中。（但实际上，这取决于您选择的 VS 设置。更多信息请参见此处。） - Cody Gray

好的，那带我去评论区...考虑将其发布为答案。如果没有更好的解决方案，我会接受它。 - Marcel

我希望有一个选项可以显示备注和返回值描述，因为微软总是没有在摘要中包含必要的信息！最典型的情况就是当我遇到陌生的集合类时。例如，字典(Dictionary<TKey, TValue>)的获取索引器(真是个术语啊！)如果键不存在就会抛出异常，但摘要没有提到这一点——只有备注中有。HashSet<T>.Remove(T item)如果不存在该项则不会报错（尽管根据哈希集的作用以及 bool 返回值，我们可以期望它会报错，但实际上并没有）。像这样的东西。 - The Dag

Answer 1

Visual Studio v16.6.5中有一个名为“编辑器帮助”的选项，位于“文本编辑器 > C# > 高级 > 编辑器帮助”下，名为“显示备注信息的快速信息”。它是最近添加的，并且默认情况下启用，但我没有找到任何关于它的发布说明或文档。我检查了版本16.5.2，它没有这样的选项。

启用后，当加入段落分隔符（空行）后，快速信息会显示备注部分。当没有总结部分时，段落分隔符仍然会在备注之前添加（不确定是否有意）。

返回值部分也类似地显示在备注部分之后，由单词"returns"分隔。但似乎没有禁用此选项的方法。

- Andrius R.

---

这是VS2019，我需要先更新，因为这似乎确实非常新！ - Marcel

我已经检查过了，它确实存在，并且默认启用。因此，这使得这个问题在未来变得过时。然而，我不会更改已接受的答案，因为该问题明确涉及较旧的VS版本。您可以考虑创建一个新的（维基）问题，并使用此答案来获得您应得的声誉。 - Marcel

我99%确定在添加此选项设置之前，VS 2019默认显示备注（但我认为它从未显示“返回”）。然后在过去的一周左右，我注意到它不再显示了；我找到了设置并且复选框已经被选中。我取消了它然后重新选中，备注又开始显示了... - Tobias J

Answer 2

把光标放在你想查看完整注释的类/函数/其他位置，然后按F12键。展开编辑器窗格左侧的注释部分。

- DFTR

---

感谢您的回复。然而，这不是我最初寻找的，因为我会失去当前光标位置。我正在寻找一种在不离开编辑器的情况下弹出的东西。 - Marcel

我也是。从整整一天的谷歌搜索来看，似乎你唯一的选择是将自定义代码片段放入Resharper中。我没有深入研究这个解决方案，因为它对我没有用处，主要是因为我不使用Resharper。 - DFTR

这是最好的解决方案（嗯，也是唯一的），会有所帮助，因此接受它。 - Marcel

Ctrl键加减号让光标回到上一个位置 :) - NickG

Resharper的东西在https://github.com/MrJul/ReSharper.EnhancedTooltip。 - CAD bloke

这将不会显示你的备注，而是备注源代码。源代码可以包含HTML实体，而备注“输出”则不包含（它正确地显示实体的字符，例如"=&quot; | &=&amp; | <=&lt; | >=&gt;）。 - MrCalvin