为Intellisense的注释添加换行符

时间:2009-01-21 21:58:46

标签: .net intellisense intellisense-documentati

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

澄清一下,假设代码文档..

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

因此,当使用此方法时,Intellisense提供了格式如下的方法的摘要:

  

一些文字文档

     

更多文档

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

5 个答案:

答案 0 :(得分:69)

尝试使用它。

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

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

答案 1 :(得分:46)

试试这个:

/// <summary>
/// <para> [Non-Breaking Space] </para>
/// </summary>
使用 Alt + 255 (使用Numpad)获得

[Non-Breaking Space]

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

答案 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>

答案 3 :(得分:7)

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

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

答案 4 :(得分:-2)

好吧,它是Xml。也许&#10;&#13;