如何在c# .NET文档中添加换行符

小开

最佳答案

你可以使用<para />标记来产生一个段落断点，或者你可以将文本包装在<para></para>标记中，作为一种对文本进行分组并在其后添加空行的方式，但没有与 或类似的东西等价的方法。(根据这旧的MS论坛帖子是设计的。)您可以从MS. 记录代码获得本文档文章中可用的标记列表

示例(基于原始OP样本):

/// <summary>
/// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para>
/// Rather than return SQL, this method returns a string with icon-tokens, which
/// could be used to represent the search in a condensed pictogram format.
/// </summary>

小开

添加一个包含特殊字符的<para>标记，255字符或不可见字符。

/// <summary>
/// Some text
/// <para>   </para>
/// More text
/// </summary>
/// <param name="str">Some string</param>
public void SomeMethod(string str) { }

它是这样工作的:

enter image description here

小开

 和 似乎不起作用，有时它并不是真的要将<para>句子分开，而是希望有一个空行用于关注点分离。我在这里提到这一点，是因为这个问题似乎是许多此类性质的封闭式问题的根源。

我发现唯一有用的是

<para>&#160;</para>

例如

/// <summary>
///     <para>
///         "This sentence shows up when the type is hovered"
///     </para>
///     <para>&#160;</para>
///     <para>int PrimaryKey</para>
///     <para>&#160;</para>
///     <para>virtual Relation Relation</para>
/// </summary>

结果

"This sentence shows up when the type is hovered"


int PrimaryKey


virtual Relation Relation

小开

这是我的用法，像 一样，它正在工作:)

/// <summary>
/// Value: 0/1/2
/// <para/>0 foo,
/// <para/>1 bar,
/// <para/>2 other
/// </summary>

小开

从Visual Studio 2019开始，注释中的换行使用 。

例子:

/// <summary>
/// This is a comment.<br/>
/// This is another comment <br/>
/// This is a long comment so i want it to continue <br/> on another line.
/// </summary>

注意，当我们使用 而不是<para>时，没有添加额外的行。