在 Intellisense 的注释中添加换行符 [重复]答案

【问题标题】：Adding line breaks to comments for Intellisense [duplicate]在 Intellisense 的注释中添加换行符 [重复]
【发布时间】：2010-10-02 19:18:58
【问题描述】：

有谁知道如何在摘要注释中插入换行符以使换行符反映在 Intellisense 文档中？

为了澄清，假设代码文档..

/// <summary>
/// Some text documentation
///  - a line break - 
/// Some more documentation
/// </summary>
public void SomeMethod() { }

因此，当使用此方法时，Intellisense 会提供该方法的摘要，格式如下：

一些文本文档

更多文档

（注意 - 'para' 标签不会创建空换行符 - 我试过了！）

【问题讨论】：

“para”是一半答案（实际上是双中断），行首和行尾被截断。要强制在摘要的开头和结尾换行，请添加以下“”（字符被省略 - 实际上不可见且零空格）。
从 Visual Studio 2019 开始，您可以在 xml 文档中使用 <br/> 添加换行符。参考答案here。

标签： .net intellisense intellisense-documentati

【解决方案1】：

试试这个。

/// <summary>
/// <para>Paragraph 1.</para>
/// <para>Paragraph 2.</para>
/// </summary>

但我不认为你可以有一个真正的空行。空的 para 标记被忽略。

【讨论】：

我以为你只是想换行。我不认为你可以有一个真正的空行。
MS 如何处理方法中的异常？
例外是 XML 中的单独标记。它不是摘要中的空白行，它只是呈现文档的不同部分
稍微好一点的版本：///
/// 第 1 段. /// 第 2 段. /// 摘要>
基本上将“<para>XYZ</para>”替换为“XYZ<para/>”

【解决方案2】：

试试这个：

/// <summary>
/// <para> [Non-Breaking Space] </para>
/// </summary>

[Non-Breaking Space] 是使用 Alt+255 获得的（使用小键盘）。

它将显示为一个空的新行。我知道这是旧的，但它今天对我有用。

【讨论】：

+1：我终于有地方写了 //魔法，不要碰。
只想说一句：哇！
这可能是我所见过的在这么多相同级别同时发生的最可怕但最可怕的事情。对于添加空行，我将使用 Al Erickson 的 &#160; 建议，但对于缩进，这更好。
Alt + 0173 看起来更像魔术。这是隐形的角色，也是有效的。
如何在VS 2015中使用Alt+255？当我在 VS 2015 中尝试 Alt+255 时没有任何反应

【解决方案3】：

/// <summary><br />
/// <para>To treat comment line like a DIV tag, surround them with PARA tags.</para><br />
/// <para>To add a break with whitespace, add the following line:</para><br />
/// <para>&#160;</para><br />
/// </summary>

【讨论】：

<br /> 单独为我工作。使用 <para> 标签创建了太多的填充，这将我的其余 cmets 推到溢出之外。
<para>&#160;</para> 是我一直在寻找的东西，tnx :)
<br /> 在 VS 2017 中不起作用。
<br/> 确实可以在 VS 2019 中使用。

【解决方案4】：

你唯一的希望可能是这样的笨拙的东西：

/// <summary>
/// <para>line one</para>
/// <para>_</para>
/// <para>line two</para>
/// </summary>

【讨论】：

cludgy 是的，但这与我目前为止的情况一样接近

【解决方案5】：

嗯，它是 Xml。也许&#10;&#13;

【讨论】：

不，也不这样做......