如何在VS 2010中为变量/字段/列表编写注释/文档？

Question

有

///<summary>
///This is summary for some class or method
///</summary>

类或方法的文档。但是如何为简单的变量或列表写这个呢？

我使用Visual Studio 2010，当我将鼠标悬停在某些列表，属性或者我希望看到的某种摘要（在那个小工具提示中）时，我已经写过那个特定的东西。

///<doc>
///always use this list!
List<String> beer = new List<String>();

编辑：好的，我们已经发现，它可以照常在您的班级中发表评论，但是OUTSIDE方法或功能!!

是否也可以在方法中记录/评论？

public class BeerForall
{
    /// <summary>
    /// it works here
    /// </summary>
    public List<String> beer = new List<string>();

    public String giveBeer()
    {
        /// is not working, u can not comment
        /// <summary>
        /// test test, not working
        /// </summary>
        List<String> moreBeer = new List<string>();

        return "beer";
    }
}

Answer 1

正如其他人提到的，您无法获得本地变量的IntelliSense。但是：如果你的函数太大而且“常规”注释不足以在你使用var的地方附近阅读，那么正确的修复就是重构函数 - break它采用多种较小的方法，减少了变量。我不认为这个功能应该存在，因为它只会促进编写过大的功能。

Answer 2

似乎在Visual Studio 2010中完美运行。我将List定义为私有字段，并在MainForm类中包含注释。

它们不适用于函数中定义的局部变量。

Answer 3

据我所知，为intellisense添加注释不适用于在函数内声明的局部变量。如果您要将本地列表作为类的实例变量，则可以执行此操作。

Answer 4

与编写变量的类和方法的摘要一样。

Answer 5

您可以向任何类成员添加此类XML documentation条评论，而不是在成员（方法，媒体资源等）中添加。{/ p>

Answer 6

编辑：它看起来像＆lt; var＆gt;仅支持JavaScript。

从Visual Studio 2012开始，您可以使用＆lt; var＆gt;添加此文档。元件。

以下是微软的文档：
https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx