为Intellisense的注释添加换行符

fle*_*esh 77 .net intellisense intellisense-documentati

有没有人知道如何在摘要注释中插入换行符,以便在Intellisense文档中反映换行符?

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

/// <summary>
/// Some text documentation
///  - a line break - 
/// Some more documentation
/// </summary>
public void SomeMethod() { }
Run Code Online (Sandbox Code Playgroud)

因此,当使用此方法时,Intellisense提供了这样格式化的方法的摘要:

一些文字文件

更多文档

(注意 - 'para'标签不会创建空换行符 - 我已经尝试过了!)

Bri*_*Kim 73

试试这个.

/// <summary>
/// <para>Paragraph 1.</para>
/// <para>Paragraph 2.</para>
/// </summary>
Run Code Online (Sandbox Code Playgroud)

但我不认为你可以有一个实际的空行.空para标记被忽略.

  • 例外是XML中的单独标记.它不是摘要中的空白行,它只是呈现文档的不同部分 (4认同)

the*_*RAY 47

试试这个:

/// <summary>
/// <para> [Non-Breaking Space] </para>
/// </summary>
Run Code Online (Sandbox Code Playgroud)

[Non-Breaking Space]是使用Alt+ 255(使用Numpad)获得的.

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

  • +1:我**终于**有一个写//魔术的地方,不要碰. (12认同)
  • 这可能是我所见过的这么多相同级别同时发生的最令人敬畏但最可怕的事情。对于添加空行,我将使用 Al Erickson 对 ` ` 的建议,但是对于缩进,这更好。 (2认同)
  • Alt + 0173 看起来更像魔法。这也是隐形的角色和作品。 (2认同)
  • 如何在 VS 2015 中使用 Alt+255?当我在 VS 2015 中尝试 Alt+255 时没有任何反应 (2认同)

小智 24

/// <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>
Run Code Online (Sandbox Code Playgroud)

  • `<para>&#160; </ para>`是我要找的东西,tnx :) (4认同)
  • `&lt;br /&gt;`在VS 2017中不起作用。 (4认同)
  • 仅`&lt;br /&gt;`对我有用。使用“&lt;para&gt;”标签创建了太多的填充,这使得我的其余评论超出了溢出范围。 (2认同)

And*_*are 7

你唯一的希望可能是像这样的cludgy:

/// <summary>
/// <para>line one</para>
/// <para>_</para>
/// <para>line two</para>
/// </summary>
Run Code Online (Sandbox Code Playgroud)