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

【问题标题】：XML multiline comments in C# - what am I doing wrong?C# 中的 XML 多行注释 - 我做错了什么？
【发布时间】：2011-02-02 14:09:36
【问题描述】：

根据this article，可以获得多行XML cmets——而不是使用///，而是使用/** */。这是我对多行 cmets 是什么以及我想要发生的事情的解释：

/**
 * <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> 或  才能达到我想要的效果。我继续使用 ，因为我想控制换行符发生的位置，即

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

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

更新

好的，我继续尝试在每一行上添加<para> 标记，这很有效。不知道为什么  没有。

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

【问题讨论】：

【解决方案1】：

添加  用于换行或将段落括在<para>...</para> 中。就像 XML 和 HTML 一样，换行符只是空格。

【讨论】：

我过去成功地使用了 ，但后来我注意到像 Swagger 这样的工具不理解它 - 所以使用<para> ... </para> 方法似乎更好（尽管@987654325 @ 更短...）

【解决方案2】：

试试这个

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

【讨论】：

【解决方案3】：

听起来您对“多行”的含义感到困惑。单行注释在源代码行的末尾结束，如果您想继续该注释，您必须在下一行添加“///”。多行注释以“/*”开头，以“*/”结尾，因此它可以在同一行或多行结束。

“多行”并没有说明评论中的文本如何显示。要在 XML 注释中添加换行符，您必须插入  （“break”）或将该行换行在 <para>（“paragraph”）标记中。

【讨论】：