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

时间:2010-03-30 17:43:16

标签: c# visual-studio-2008 comments multiline xml-comments

根据this article,可以获取多行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>

3 个答案:

答案 0 :(得分:16)

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

“多行”不会说明评论中的文本是如何显示的。要在XML注释中添加换行符,必须插入<br/>(“break”)或将行包装在<para>(“paragraph”)标记中。

答案 1 :(得分:13)

试试这个

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

答案 2 :(得分:0)

为换行符添加<br/>或将段落括在<para>...</para>中。就像XML和HTML一样,换行符只不过是空格。