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

Question

这应该更容易...

我想在我的代码中的 XML 文档中添加一个“编码”换行符

/// <summary>
/// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt;
/// 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>

如您所见，我找到了一些答案，演示了添加 <和>括号。 有趣的是，好'ol < br/>换行符不会在 Intellisense 弹出窗口中创建换行符。

我觉得这很烦人...

有什么建议吗？

Answer 1

您可以使用 标记来生成段落分隔符，也可以将文本包裹在 标记中将文本分组并在其后添加空行，但没有与
或类似的内容等效的内容。 （根据 这个旧的 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>

Answer 2

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

请注意，当我们使用
而不是 。

Answer 3

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

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

Answer 4

添加一个 标记，其中包含特殊字符、255 个字符或 不可见字符。

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

它将像这样工作：

Answer 5

和
似乎不起作用，有时它并不是真正关于制作 < ;para> 句子之间的分隔程度与希望有一个空行来分隔关注点一样多。我在这里提到这一点是因为这个问题似乎是许多此类性质的封闭问题的根源。

我发现唯一有效的方法是

<para> </para>

例如

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

结果

"This sentence shows up when the type is hovered"

int PrimaryKey

virtual Relation Relation