如何在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>

正如您所看到的，我找到了一些证明添加＆lt;和＆gt;括号。 有趣的是，良好的'ol＆lt; br /＆gt;换行符不会在Intellisense弹出窗口中创建换行符。

我觉得这很烦人......

有什么建议吗？

Answer 1

您可以使用<para />标记生成分段符，或者可以将<para></para>标记中的文本换行，以便对文本进行分组并在其后添加空白行，但没有相应的内容到<br />或类似的东西。 （根据this旧版MS论坛帖子的设计。）您可以从MS获取此文档文章中的可用标记列表。 Documenting your code

示例（基于原始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

这是我的用法，如<br/>，其工作：）

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

Answer 3

添加一个带有特殊字符的<para>标记，255个字符或invisible char。

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

它会像这样工作：

Answer 4

从Visual Studio 2019开始，支持使用<br/>进行注释以创建带有新行的注释。

例如：

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

您可以在下图中看到上面的示例。

请注意，与使用<br/>标签相比，使用<para>标签时没有添加额外的行。

Answer 5

<br></br>和<br />似乎不起作用，有时候并不是真的要将<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