logo标签列表

为Intellisense添加C#注释换行

.netintellisensecode-documentation
80

有人知道如何在摘要注释中插入换行符，以便在 IntelliSense 文档中反映出换行符吗？

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

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

使用此方法时，Intellisense会提供一个格式化为以下内容的方法摘要：

 

一些文本文档

    

更多文档

（注意-“para”标签不会创建空行 - 我已经尝试过了！）

“Para”是半个答案（实际上是双倍断点），行的开头和结尾被截断。为了在摘要的开头和结尾强制换行，请添加以下内容：“<para></para>”（字符会被省略 - 实际上是不可见的零空间）。 - SoLaR
2
从Visual Studio 2019开始，您可以在xml文档中使用<br/>添加换行符。请参考此处的答案。 - Mahipal
5个回答
77

试着使用这个。

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

但我认为您不能真正拥有空行。 空段落标记会被忽略。

我以为你只是想要一个换行符。我不认为你可以有一个真正的空行。 - Brian Kim
微软是如何在方法中处理异常的呢？ - flesh
4
在XML中，异常是单独的标签。它不是摘要中的空白行，而只是呈现文档不同的部分。 - bdukes
稍微好看一点的版本：/// /// 第一段。 /// 第二段。 /// - Peter Huber
抱歉格式不太好看，但愚蠢的stackoverflow在5分钟后不允许更改评论，并且无论如何都无法进行适当的格式化。请参见下一个评论中的正确示例。 - Peter Huber
1
基本上将“<para>XYZ</para>”替换为“XYZ<para/>”。 - Peter Huber
47

试一下这个：

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

[Non-Breaking Space]可通过使用Alt+255（使用数字键盘）获得。

它将显示为空的新行。我知道这很古老，但今天它对我有用。

14
+1: 我终于有一个写魔法的地方了 // 魔法，勿动。 - Louis Kottmann
2
这可能是我见过的在许多相同层面上同时发生的最棒和最可怕的事情。为了添加空行，我将使用Al Erickson的建议&#160;，但对于缩进，这种方法更好。 - Daryl
进来吧，我的孩子！太棒了。 - Jack Pettinger
2
Alt + 0173 看起来更像是魔法。它是不可见的字符，也能正常工作。 - Martin Braun
2
如何在VS 2015中使用Alt+255？当我尝试在VS 2015中使用Alt+255时，什么也不会发生。 - srh
显示剩余4条评论
28
/// <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>
2
<br /> 对我来说是有效的。使用 <para> 标签会创建太多填充，这会将我的其余注释推到溢出之外。 - drzaus
4
“<para> </para>”是我在寻找的东西，谢谢 :) - Krowi
4
在VS 2017中，<br />无法正常工作。 - David
1
<br/> 在 VS 2019 中可以正常工作。 - Tam Le
尽管其使用了相当古老的HTML标签，但该被接受的答案在VS 2022中仍然有效。 - Peter
作为一种简写方式，您还可以在每行末尾使用一个空标签：<para />。 - Nick
7
你唯一的希望可能是采用以下笨拙的方法之一：
/// <summary>
/// <para>line one</para>
/// <para>_</para>
/// <para>line two</para>
/// </summary>
虽然有些笨拙，但这是我目前为止能做到的最好的。 - flesh
-3

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

5
不行，这也不行…… - flesh
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接