XML多行注释在C# – 我做错了什么?

前端之家收集整理的这篇文章主要介绍了XML多行注释在C# – 我做错了什么?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
根据 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>
听起来你对“多行”的含义感到困惑。单行注释在源代码行的结尾处结束,如果要继续该注释,则必须在下一行放置一个“///”。多行注释以“/ *”开头,以“* /”结尾,因此它可以在同一行或多行下结束。

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

猜你在找的XML相关文章