C# 中的 XML 多行注释 - 我做错了什么？

Question

根据这篇文章，可以获得多行 XML 注释——不要使用

///

，而是使用

/** */

。 这是我对多行注释的解释，以及我希望发生的事情：

/**
 * <summary>
 * this comment is on line 1 in the tooltip
 * this comment is on line 2 in the tooltip
 * </summary>
 */

但是，当我使用这种形式时，当我将鼠标悬停在代码中的类名上时弹出的工具提示是单行的，即它看起来就像我写了这样的评论：

/// <summary>
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
/// </summary>

这种行为在 VS2008 中实际上仍然可能吗？

编辑

gabe 指出我误解了“多行”的含义，实际上我需要使用

<para>

或

<br>

才能达到我想要的效果。 我继续使用

<br>

因为我想控制换行发生的位置，即

/// <summary>
/// this comment is on line 1 in the tooltip<br/>
/// this comment is on line 2 in the tooltip<br/>
/// </summary>

当我在代码中查看此类的工具提示时，所有内容仍然以一行结束......WTH？ 我在这里做错了什么吗？

更新

好吧，我继续尝试每行上的

<para>

标签，效果很好。 不知道为什么

<br/>

没有。

/// <summary>
/// <para>this comment is on line 1 in the tooltip</para>
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>

Answer 1

听起来您对“多行”的含义感到困惑。单行注释在源代码行的末尾结束，如果您想继续该注释，则必须在下一行添加“

///

”。多行注释以“

/*

”开头，以“

*/

”结尾，因此它可以在同一行或多行结束。

“多行”并没有说明评论中的文本如何显示。要在 XML 注释中添加换行符，您必须插入

<br/>

（“换行符”）或将行换行到

<para>

（“段落”）标签中。

Answer 2

试试这个

/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>

Answer 3

添加

<br/>

用于换行或将段落括在

<para>...</para>

中。就像 XML 和 HTML 一样，换行符只是空格。

Answer 4

/// <summary>
/// <para>
/// This is First hint line <br/> dont forget slash : ) cuz this is second hint line <br/>
/// Third Line
/// Third Line Continues : ) <br/> oh! this is the last line ;)
/// </para>
/// </summary>
public string[] tagsToIgnore;