VS2010：在预览中查看方法注释？

Question

我通常会为我创建的每个方法添加简短描述。当我去方法定义时，我可以阅读这个描述/评论，我知道该方法的作用。

是否可以在方法预览中看到这些注释？例如，如果我将光标放在调用的方法上，则会使用方法签名显示一个小弹出窗口。当光标在方法上时，是否也可以看到方法注释？

我不想去实际的方法来看它的作用。

感谢。

Answer 1

是的，这是可能的。您需要使用C# XML Documentation格式将评论添加为summary元素。

class MyClass
{
    /// <summary>
    /// Does something.
    /// </summary>
    /// <param name="foo">The input.</param>
    /// <returns>The result.</returns>
    public int DoSomething(string foo)
    {
        Console.WriteLine(foo);
        return 3;
    }
}

通过上面定义的文档，Intellisense提供以下内容：

Answer 2

使用XML评论。当您使用Intellisense时，这些应该是可见的。

示例：

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

见这里：https://msdn.microsoft.com/en-us/library/vstudio/b2s063f7%28v=vs.100%29.aspx