对象摘要中的NewLine

Question

问候

为属性/字段/方法等设置摘要时,是否可以在其中添加换行符？

/// <summary>
/// This is line 1
/// This is line 2
/// </summary>
public bool TestLine { get; set; }

当我设置它时,它显示为鼠标悬停:

bool TestLine
This is line 1 This is line 2

但我希望它显示为:

bool TestLine
This is line 1 
This is line 2

我尝试过使用\n但不起作用.有没有办法完成这项工作？

Answer 1

你想用这样的东西

/// <summary> 
/// Your Main comment 
/// <para>This is line 1</para> 
/// <para>This is line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

Answer 2

是:

/// <summary> 
/// Main comment 
/// <para>Line 1</para> 
/// <para>Line 2</para> 
/// </summary> 
public bool TestLine { get; set; }

Answer 3

这可能是一个旧线程，但我在使用Visual Studio 2019时正在搜索 anwser 。我想要段落和换行符。以下对我来说效果很好：

/// <summary>
/// <para>parameter name="guidType" options:</para>
/// <br>0 = SequentialAsString</br>
/// <br>1 = SequentialAsBinary</br>
/// <br>2 = SequentialAtEnd</br>
/// </summary>

产生以下内容：

parameter name="guidType" options:

0 = SequentialAsString
1 = SequentialAsBinary
2 = SequentialAtEnd

Answer 4

如果您想在摘要中包含多行而不使其变得复杂，我建议使用此格式。如果您在每行后面使用 <br /> 标记，它就会起作用。（在文本内的任何位置使用它都会在标签所在的位置创建一个新行。）

不过，请注意，如果 <br /> 标记后面有一个空格，则下一行会多一个空格。所以你希望每行都有相同的空间，这样每一行都会成一条直线。

/// <summary>
/// This is line 1<br />
/// This is line 2<br />
/// This is line 3<br />
/// </summary>
public bool TestLine { get; set; }

Answer 5

您可以合法地添加 para 标签，但这实际上会为每个新行创建一个新段落，并且行距会出现关闭。
我个人在段落周围添加 1 段，然后在br我想要中断的行末尾添加标签，这样可以保留适当的行距：

/// <summary> 
/// <para>Main comment<br /> 
/// Line 1<br />
/// Line 2</para> 
/// </summary>
public bool TestLine { get; set; }

Answer 6

您可以用来<para />在摘要中添加新行：

/// <summary> 
/// Main comment<para />
/// Line 1<para />
/// Line 2<para />
/// </summary>
public bool TestLine { get; set; }

看起来像：

Main comment
Line 1
Line 2

最好的祝福！