在Intellisense注释中显示空行

Question

在Intellisense注释中显示空行

.netxmlvb.netvisual-studio-2012intellisense

4

在此之前，我要澄清一点：这个问题是关于 VB.NET 的，而不是 C#。这个问题不是重复的，因为从这里获取的任何解决方案都不能在 VS2012 上实现（如何在 C# .NET 文档中添加换行符）或者（为智能感知添加注释换行符）。

我想添加一个空行来显示以下的 Intellisense 信息：

Public Enum StringCase As Short

''' <summary>
''' LowerCase
''' (Empty line)
''' [Example]   + (line break)
''' Input : ABC + (line break)
''' Output: abc
''' </summary>
Lower = 0

End Enum

更新：

在Windows 8 x64上使用浅色和深色主题，测试了在VS2012 Ultimate上（有和没有官方更新）使用断行标签的效果。

enter image description here

- ElektroStudios

可能是 Multiline XML Comments in VB.Net and Visual Studio Intellisense 的重复问题。 - Hans Passant

1

@Hans Passant 只是离题一下：我确定如果你不知道如何去做，那么就不存在任何可能的方式去做。但奇怪的是，Visual Studio产品团队关闭了那个评论链接中的问题，而没有提供任何解决方案！ - ElektroStudios

考虑使用 ReSharper。它可以正确地显示 XML 文档注释（支持 br 和 para，如果我没记错的话），并且包含许多其他功能，这些功能将提高您的生产率。没有 R# 的 VS 真是太差了。 - Athari

3个回答

3

我的第一反应是使用

<para>foo</para>

因为这在VS2008中适用于注释，参见http://social.msdn.microsoft.com/Forums/en-US/5dce48f5-d810-46bd-bb9b-6d0478174cf2/xml-comments-how-to-insert-a-new-line?forum=csharpide

您是否考虑将您的注释放入CDATA或类似内容以尝试保留空格？

http://msdn.microsoft.com/en-us/library/vstudio/ms255811(v=vs.100).aspx

我记得这更像是IDE的格式化问题，不过我认为像Doxygen这样的文档生成工具会遵守空格规则。

- finman

尝试过了但是问题没有解决，我的 CDATA 摘要行被 IntelliSense 忽略了：''' <![CDATA[ something ]]> 或许我做错了什么。 - ElektroStudios

2

如果您将想要换行的文本用“para”标签括起来，它就会做您想要的事情。

''' <summary>
''' LowerCase
''' <para></para>
''' <para>[Example]</para>
''' <para>Input</para>
''' <para>Output</para>
''' </summary>

- skynetsysadmin

不，它在VS2012中不行。我已经测试过了。 - ElektroStudios

2

<para> </para>会创建一个空白行，是Unicode中的不间断空格字符。 - McGuireV10

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Humanier · Accepted Answer

您可以使用HTML的<br/>标签来创建空行和换行。

这在C#中有效。

    /// <summary>
    /// LowerCase
    /// <br/><br/>
    /// [Example]<br/>
    /// Input<br/>
    /// Output<br/>
    /// </summary>

在VB中应该这样写：

    ''' <summary>
    ''' LowerCase
    ''' <br/><br/>
    ''' [Example]<br/>
    ''' Input<br/>
    ''' Output<br/>
    ''' </summary>