对象汇总中的新行

你好

当为属性/字段/方法等设置摘要时..。有没有可能换行？

/// <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，但是没有用。有什么办法可以做到这一点吗？

57258 次浏览
小开
最佳答案

你应该用这样的东西

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

是的:

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

您可以合法地添加 para 标记，但是这实际上为每个新行都创建了一个新段落，而且行间距显示为空。
我个人在段落周围添加了1段，然后在行尾添加了 br标签，这样就保留了不错的行距:

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

如果您希望摘要中有多行内容，而又不会使其复杂化，我建议使用这种格式。如果您使用 在每行之后使用 < br/> 标记。(在文本中的任何位置使用它将生成一个新行，其中也包含标记) ，那么它将工作

尽管如此，请注意，如果在 < br/> 标记后面有一个空格，那么在下一行后面就会有一个额外的空格。所以每一行的空间都是一样的，所以每一行都是直线。

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

我只是为像我一样使用 Xamarin Studio 的人添加这个。我发现以上的方法都不适合我，但这个方法适合我:

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

结果如下:

Summary
Main summary line.


Your secondary summary
小开

如果您正在使用 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/>的使用情况。

小开

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

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

看起来像:

Main comment
Line 1
Line 2

最好的问候！

小开

这可能是一个老线程，但我正在寻找一个答案，而使用 Visual Studio 2019。我想要段落和行间断。下面的方法对我很有效:

/// <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

提交答案