在Microsoft Visual C#2010 Express中,每当我创建一个函数,并使用3个斜杠创建帮助代码时,我会得到这样的结果:
/// <summary>
/// Function to sum 2 numbers.
/// </summary>
/// <param name="foo">First number.</param>
/// <param name="bar">Second number.</param>
/// <returns>The sum of the numbers.</returns>
public int foobar( int foo, int bar )
{
return foo + bar;
}
我知道无论什么时候我想知道函数是做什么的,我都可以将鼠标悬停在它上面,工具提示会显示<summary>
标记之间的文字。
此外,每当我打开括号来编写我正在调用的函数的参数时,我会看到光标下方的工具提示,它显示在<param name="foo">
标记之间写入的文本。
所以,我的问题是:我是否可以查看<returns>
标签之间的文字而无需定义并在其编写的代码中查看它?如果是这样,怎么样?
答案 0 :(得分:7)
您可以在View >> Object Browser
中查看。
除此之外,你不会在其他任何地方看到它。
如果您想通过工具提示显示“返回”信息,那么最好将其作为描述的一部分放在<summary>
本身内。
当您想要在其中添加更多文本时,有一些可能使<summary>
更具可重复性。使用<para>
:
///<summary>
///<para>line1</para>
///<para>line2 (e.g. what a method returns)</para>
///</summary>