这应该容易得多……

我想在代码中的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/ >换行符不会在智能感知弹出窗口中创建换行符。

我觉得这很烦人……

有什么建议吗?


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

示例(基于原始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) { }

它是这样工作的:


<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

这是我的用法,像<br/>, it's working:)

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

从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>时,没有添加额外的行。