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


196

这应该更容易...

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

我觉得这很烦人...

有什么建议?


3
从Visual Studio 2019开始,可以使用<br/>创建换行符。请在此处参考答案。
19bl

Answers:


314

您可以使用<para />标记来产生段落分隔符,也可以将文本包装在<para></para>标记中,以将文本分组并在其后添加空白行,但是没有等效项<br />或类似的东西。(根据这个旧的MS论坛帖子,是设计使然。)您可以从MS获得此文档文章中的可用标签列表。记录代码

示例(基于原始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>

5
啊哈!现在正在做饭!谢谢!这已经困扰了我很长一段时间了……我看到列出了para选项,但是假设它是“ paramater”快捷方式。
Tinkerer_CardTracker

2
没有为我工作。在VS 2010上使用VB.NET(在使用和不使用Powertools的彩色参数选项的情况下尝试使用)<para>,都会忽略标签,并且所有内容在Intellisense中混合为一行。找到了这个问题,汉斯在这里解释了问题:stackoverflow.com/questions/7070737/…
Neolisk

1
确保还添加了结束

85
不好的是,它实际上添加了一个完整的空白行,而不是仅添加新行。
戴维

6
那么,有没有人找到一种方法来实际插入一行而不是两行呢?

75

这是我的用法,就像<br/>,它正在工作:)

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

8
为什么这个答案不好?它的工作原理,似乎是比使用一个更好的解决方案<para>&#160;</para><para>&nbsp;</para>或不可见字符...
Dinei

这适用于换行符,但不会像其他选项一样在各行之间插入空白行。
Yushatak

15
在最新版本的VS中,<para/>似乎添加了一个空白行,而不仅仅是换行符。
Dinei

2
@IlPADlI,用法示例为+1。已确认正在使用VS 2012 Ultimate
Update5。– Dennis T –恢复Monica

9
VS 2017:添加了空白行,而不仅仅是换行符... Microsoft肯定喜欢告诉我们我们想要做什么...
Assimilater

39

从Visual Studio 2019开始,<br/>在注释中使用换行符。

例:

/// <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>

在此处输入图片说明

请注意,当我们使用<br/>而不是时,没有添加任何额外的行<para>


4
仍然有用,因为此问题是有关如何在C#文档中添加换行符的google最高搜索结果。

27

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

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

它将像这样工作:

在此处输入图片说明


8
这很有用,但是&nbsp;不起作用,而是使用/// <para>&#160;</para>
Robert H

1
我个人留/// <para> </para>在便签中。然后,只需复制和粘贴!(而且有效-至少对我而言)
Joel

2
我不知道为什么,但是复制粘贴/// <para> </para>根本不起作用。 /// <para>&#160;</para>作品!
强2014年

8
而不是<para>在文本块之间使用标签,而应在元素以外<para>所有段落周围使用标签。对于,,,,和元素,用身边的所有段落,如果你有一个以上的(可选,如果你只有一个这些元素)。对于所有其他块元素(包括另一个块元素的内部),即使您只有一个段落,也请在所有段落周围使用标签。<summary><typeparam><param><value><exception><returns><note><para>
山姆·哈威尔

1
资料来源:我撰写了这篇文章,包括大部分的演讲风格:openstacknetsdk.org/docs-master/html/…–
Sam Harwell

3

<br></br><br />没有看起来的工作,有时它是不是真正的使<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
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.