78

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

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

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

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

一些文本文档

更多文档

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

4

5 回答 5

75

尝试使用这个。

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

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

于 2009-01-21T22:01:05.770 回答
47

尝试这个:

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

[Non-Breaking Space]使用Alt+获得255(使用数字键盘)。

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

于 2012-05-10T20:49:28.117 回答
25
/// <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>
于 2009-03-25T14:58:55.173 回答
7

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

/// <summary>
/// <para>line one</para>
/// <para>_</para>
/// <para>line two</para>
/// </summary>
于 2009-01-21T22:20:11.783 回答
-3

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

于 2009-01-21T22:16:07.907 回答