c# - 对象摘要中的新行

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

这可能是一个旧线程，但我在使用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 3

是的：

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

Answer 4

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

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

好像：

Main comment
Line 1
Line 2

此致！

Answer 5

您可以合法地添加 para 标记，但这实际上会为每个新行创建一个新段落，并且行距会消失。
我个人在段落周围添加 1 段，然后br在我想要中断的行末尾添加标签，这样可以保持不错的行距：

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

Answer 6

如果您希望摘要中有多行而不使其变得复杂，我建议您使用这种格式。如果您在每一行之后使用 <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 7

我只是为像我一样使用 Xamarin Studio 的任何人添加这个。我发现上述解决方案都不适合我，但这个解决方案可以：

/// <summary>
/// Main summarry line.
/// <para></para>
/// <para></para>
/// Your secondary summary
/// </summary>

这给出了以下输出：

Summary  
Main summary line.

Your secondary summary

Answer 8

如果您使用的是 Swashbuckle（Swagger Web API 集成库），那么<para></para>应该替换为<p></p>也<br/>可以使用。

所以以下

    /// <para>
    ///     Flag1, Flag2
    ///     - bool flags, optional.
    /// </para>

变成

    /// <p>
    ///     Flag1, Flag2<br/>
    ///     - bool flags, optional.
    /// </p>

该问题已在此处描述： 如何在 Swashbuckle 文档中添加换行符？- 使用特殊配置，domaindrivendev 的评论， https://github.com/domaindrivendev/Swashbuckle/issues/258 - 关于<br/>使用。