【问题标题】:Visual Studio 2017: <list> not showing correctly on hover (xml documentation)Visual Studio 2017:<list> 在悬停时未正确显示(xml 文档)
【发布时间】:2018-11-14 11:05:25
【问题描述】:

如果您将鼠标悬停在 VS17 (15.6.2) 中具有 xml 文档 (///&lt;summary&gt;&lt;/summary&gt;) 的某些内容(类、方法...)上,您会看到这个显示 cmets 格式正确的小弹出窗口。

我试着列个清单(复制自here):

/// <summary>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description>Item 1.</description>
/// </item>
/// <item>
/// <description>Item 2.</description>
/// </item>
/// </list>
/// </summary>

但弹出窗口只显示在一行中:

Here is an example of a bulleted list: Item 1. Item 2.

我还尝试将&lt;term&gt; 添加到其中(例如here),但我得到的只是:

我也尝试过使用其他types(也没有尝试过),但没有任何变化。这是一个错误吗?我该如何解决?

【问题讨论】:

  • 如果您想将描述显示为多行文本,您可以设置分段符 - SOURCE
  • @Wojtman 我已经尝试过&lt;para&gt;&lt;/para&gt;,这似乎也有点破:而不是仅仅添加一个换行符(如您所料,请参见第二张截图here)它加了 2,这让它看起来更糟。
  • 我同意。我希望悬停时摘要的格式更健壮一些。我们经常定义新的(单行)类,这些类继承自另一个具有泛型类型的类(使用 StrangeIOC 信号系统——如果你好奇的话)。它通常看起来像:public class SomeCustomSignal : Signal&lt;string, int&gt; { } 我希望能够列出信号参数是什么,类似于任何函数,但我不能让它看起来很好。
  • 还是坏了;几年后 VS17 的工具提示中没有列表/表格视图!
  • 这终于在 Visual Studio 2019 中修复了!

标签: c# visual-studio visual-studio-2017 xml-comments


【解决方案1】:

这是我的解决方法:

/// <summary>Here is an example of a bulleted list:
/// <list type="bullet">
/// <item>
/// <description><para>&#x02022; Item 1.</para></description>
/// </item>
/// <item>
/// <description><para>&#x02022; Item 2.</para></description>
/// </item>
/// </list>
/// </summary>

【讨论】:

  • 有趣,这是一个很好的解决方法,看起来与最终在 VS 2019 中修复的 cmets 完全相同。
猜你喜欢
  • 2017-11-17
  • 1970-01-01
  • 2017-10-15
  • 1970-01-01
  • 2018-08-18
  • 1970-01-01
  • 1970-01-01
  • 2017-09-11
  • 1970-01-01
相关资源
最近更新 更多