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

我只是为使用Xamarin Studio的人添加此功能，就像我一样。我发现以上解决方案都不适合我，但这个解决方案确实如此：

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

这给出了以下输出：

Summary  
Main summary line.

Your secondary summary

Answer 5

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

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

看起来像：

Main comment
Line 1
Line 2

最诚挚的问候！

Answer 6

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

以下

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

变为

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

此问题已在此处描述： How to add line break to Swashbuckle documentation? - 使用特殊配置，domaindrivendev的评论， https://github.com/domaindrivendev/Swashbuckle/issues/258 - <br/>使用情况。

Answer 7

您可以合法地添加para标签，但这实际上会为每个新行创建一个新段落，并且行间距显示为关闭。
我个人在段落周围添加了1个para，然后在行的末尾添加了br个标签，我希望有一个间隔，这样可以保留适当的行间距：

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

Answer 8

如果您想在摘要中使用多行而不使其复杂化，我建议您使用此格式。如果你使用＆lt; br /＆gt;它会工作。每行后面的标记。（在文本中的任何地方使用它都会在标记所在的位置创建一个新行。）

虽然，请注意，如果你在＆lt; br /＆gt;之后有空格标签，你会在下一行获得额外的空间。所以你想在每条线上都有相同的空间，所以每一行它都是一条直线。

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

对象摘要中的NewLine

8 个答案: