C#中的XML多行注释-我做错了什么?
根据,可以获取多行XML注释——而不是使用C#中的XML多行注释-我做错了什么?,c#,visual-studio-2008,comments,multiline,xml-comments,C#,Visual Studio 2008,Comments,Multiline,Xml Comments,根据,可以获取多行XML注释——而不是使用//,而是使用/***/。这是我对什么是多行注释以及我希望发生什么的解释: /** * <summary> * this comment is on line 1 in the tooltip * this comment is on line 2 in the tooltip * </summary> */ /** * *此注释位于工具提示的第1行 *此注释位于工具提示的第2行 * */ 但是,当我使用此表单时
//
,而是使用/***/
。这是我对什么是多行注释以及我希望发生什么的解释:
/**
* <summary>
* this comment is on line 1 in the tooltip
* this comment is on line 2 in the tooltip
* </summary>
*/
/**
*
*此注释位于工具提示的第1行
*此注释位于工具提示的第2行
*
*/
但是,当我使用此表单时,当我在代码中将鼠标悬停在类名上时弹出的工具提示是单行的,即,它看起来就像我写的注释是这样的:
/// <summary>
/// this comment is on line 1 in the tooltip
/// this comment is on line 2 in the tooltip
/// </summary>
//
///此注释位于工具提示的第1行
///此注释位于工具提示的第2行
///
在VS2008中,这种行为真的可能吗
编辑
gabe指出,我误解了“多行”的含义,实际上我需要使用
或
来达到预期效果。我继续使用
,因为我想控制换行符出现的位置,即
/// <summary>
/// this comment is on line 1 in the tooltip<br/>
/// this comment is on line 2 in the tooltip<br/>
/// </summary>
//
///此注释位于工具提示的第1行
///此注释位于工具提示的第2行
///
当我在我的代码中看到这个类的工具提示时,所有的东西仍然在一行中结束。。。什么?我做错什么了吗
更新
好的,我继续在每一行上尝试了
标记,这很有效。不知道为什么
没有
/// <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行
///此注释位于工具提示的第2行
///
为换行符添加
,或将段落括在..
中。就像XML和HTML一样,换行符只不过是空白。试试这个
/// <summary>
/// this comment is on line 1 in the tooltip
/// <para>this comment is on line 2 in the tooltip</para>
/// </summary>
//
///此注释位于工具提示的第1行
///此注释位于工具提示的第2行
///
听起来你对“多行”的含义感到困惑。一行注释在源代码行的末尾结束,如果要继续该注释,必须在下一行添加“//
”。多行注释以“/*
”开头,以“*/
”结尾,因此可以在同一行或多行下结束
“多行”并不能说明注释中的文本是如何显示的。要在XML注释中插入换行符,您必须插入一个
(“换行符”)或将该行包装在
(“段落”)标记中。谢天谢地。谢谢你澄清这一点,我肯定对“多行”指的是什么有不同的概念。我很高兴我可以重新使用//,我将开始使用!实际上,我确实需要使用,因为我想控制换行符。我继续在注释的每一行末尾添加了
,但它仍然将工具提示中的所有内容放在一行。@gabe:你知道如何保留空白吗?你想保留什么空白?如果只是空格,可以使用
。在Visual Studio for intellisence中没有为我工作,但是角色 ;似乎做到了。有人知道如何在XML注释中保留空白吗?如果可能的话,我希望有缩进。我过去成功地使用了
的可能副本,但后来我注意到像Swagger这样的工具不理解它-因此,使用似乎更好代码>方法(虽然
要短得多…)