在Intellisense评论中显示空行

时间:2013-11-15 04:54:14

标签: .net xml vb.net visual-studio-2012 intellisense

在此之前,我想澄清一下这个问题是关于VB.NET不是 C#,这个问题并不重复,因为任何解决方案都可以在这里工作{{3} }或How to add a line break in C# .NET documentation(至少在VS2012上)。

我想添加一个空行来显示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旗舰版的断线标签(有和没有官方更新)。

enter image description here

3 个答案:

答案 0 :(得分:3)

您可以使用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>

答案 1 :(得分: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

IIRC它更像是IDE的格式化东西,但我认为像Doxygen这样的doc生成工具会观察空白

答案 2 :(得分:2)

如果你在“para”标签中包含你想要打破的行,它应该做你想要的。

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