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

【问题标题】：How to add a line break in C# .NET documentation如何在 C# .NET 文档中添加换行符
【发布时间】：2011-09-02 04:02:25
【问题描述】：

这应该更容易...

我想在我的代码中为 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 换行符不会在 Intellisense 弹出窗口中创建换行符。

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

有什么建议吗？

【问题讨论】：

从 Visual Studio 2019 开始，可以使用
创建换行符。参考答案here。

标签： c# .net xml-documentation

【解决方案1】：

您可以使用<para /> 标记来生成分节符，或者您可以将文本换行在<para></para> 标记中作为对文本进行分组并在其后添加空行的一种方式，但没有与  等效的方法或类似的东西。（根据 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>

【讨论】：

啊哈！现在正在做饭！谢谢！这一直困扰着我很长时间......我看到列出的 para 选项，但认为它是一个“参数”快捷方式。
对我不起作用。在 VS 2010 上使用 VB.NET，尝试使用和不使用 Powertools 的彩色参数选项，<para> 标记被忽略，所有内容都在 Intellisense 中混合成一行。找到了这个问题，汉斯解释了这个问题：stackoverflow.com/questions/7070737/…。
确保你也添加了结束标记 =)
这样做的坏处是它实际上添加了一个完整的空白行，而不仅仅是新行。
那么有没有人找到一种方法来实际插入一行而不是两行？

【解决方案2】：

从 Visual Studio 2019 开始，在 cmets 中使用   作为换行符。

例子：

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

【讨论】：

仍然有用，因为这个问题是关于如何在 C# 文档中添加换行符的谷歌搜索结果。
这个答案需要更高，或者被接受为正确答案，它隐藏在2个答案下面告诉你使用<para/>。
如果它在 Visual Studio Code 和 Visual Studio 2019 中都能正常工作，我会投赞成票。也许我错过了一个设置，但
在 VSC 中对我没有任何帮助。不过感谢 VS 的提示！
另见正文部分：docs.microsoft.com/en-us/dotnet/csharp/language-reference/… 他们也建议现在使用
标签。 ;-)

【解决方案3】：

这是我的用法，例如   ，它正在工作:)

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

【讨论】：

为什么这个答案被否决了？它有效，而且似乎是比使用<para>&#160;</para>、<para>&nbsp;</para> 或隐形字符更好的解决方案...
在最新版本的VS中<para/>似乎添加了一个空行，而不仅仅是一个换行符。
@IlPADlI，使用示例 +1。确认正在开发 VS 2012 Ultimate Update 5。
VS 2017：添加了空行，而不仅仅是换行...微软当然喜欢告诉我们我们想要做什么...
@Assimilater：欢迎您编写自己的操作系统、IDE 以及所有其他您不满意的 Microsoft 工具。

【解决方案4】：

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

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

它将像这样工作：

【讨论】：

这很有帮助，但是&nbsp; 不起作用，请改用/// <para>&#160;</para>
我个人将/// <para> </para> 保存在便笺中。然后它只是复制和粘贴！（而且它有效 - 至少对我而言）
我不知道为什么，但是复制粘贴/// <para> </para> 根本不起作用。 /// <para>&#160;</para> 工作！
不要在文本块之间使用<para>标签，您应该在所有段落周围使用<para>标签除了<summary>元素中的第一个。对于<typeparam>、<param>、<value>、<exception> 和 <returns> 元素，如果您有多个段落，请在 all 段落周围使用它们（如果您只有一个段落，则可选这些元素）。对于所有其他块元素（包括另一个块元素内的<note>），在所有段落周围使用<para> 标签，即使您只有一个。
来源：我撰写了这个，包括大部分演示风格：openstacknetsdk.org/docs-master/html/…

【解决方案5】：

  和  似乎不起作用，有时这并不是为了让<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

【讨论】：