C# 如何在VS2010中为变量/字段/列表编写注释/文档？

有

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

///
///这是某些类或方法的摘要
///

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

我使用VisualStudio2010，当我将鼠标悬停在某个列表、属性或任何我想看到的东西上时（在那个小工具提示中），我已经为那个特定的东西编写了一些摘要

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

///
///始终使用此列表！
列表啤酒=新列表（）；

编辑：好的，我们已经发现，只要你在你的类中注释，但在方法或函数之外，它就会像往常一样工作

还有什么方法可以在方法中记录/注释

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";
    }
}

公共类BeerForall
{
/// 
///它在这里工作
/// 
公共列表啤酒=新列表（）；
公共字符串
{
///不工作，你不能评论
/// 
///测试，不工作
/// 
List moreBeer=新列表（）；
返回“啤酒”；
}
}

编写类摘要的方法与编写变量方法的方法相同。

您可以将此类注释添加到任何类成员中，而不是添加到成员（方法、属性等）中。

在Visual Studio 2010中似乎工作得非常好。我将列表定义为一个私有字段，在MainForm类中带有注释

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

---

据我所知，为intellisense添加注释对函数中声明的局部变量不起作用。如果要将本地列表作为类的实例变量，则可以这样做。

正如其他人提到的，您无法获得本地变量的IntelliSense。但是：如果您的函数太大，以至于“常规”注释距离您使用变量的位置太近，无法读取，那么正确的修复方法是重构函数——将其分解为多个更小的方法，使用更少的变量。我认为这个功能不应该存在，因为它只会帮助编写过大的函数。

Edit：看起来只有JavaScript支持它

从Visual Studio 2012开始，您可以使用元素添加此文档

以下是Microsoft的相关文档：

---

它适用于所有属性和字段，可能不适用于函数中的任何变量？该死，你是对的：/n在方法中不起作用。在类中，u可以像往常一样记录文档，但在方法/函数中它不起作用！有什么方法可以让它工作吗？是的，它对方法有效吗？您的方法是在哪里定义的，您从哪里调用它？如果以智能感知方式显示，则会显示注释。有时加载可能只需要几秒钟。您无法记录局部变量。Oops。没有在方法中看到，不，这不起作用。在类本身中，它起作用。但是试着在一个方法中记录一些东西。看我编辑的第一篇博士后这是我在对你的问题的第一次评论中说的，你不能记录方法本身定义的变量。如果你能使它适用于局部方法级别的变量，那就太酷了。。只是为了让你的本地代码有智能感知。我的意思是，为什么不呢？不幸的是，链接文档只适用于Javascript。我试着在局部变量上使用

，没有效果。也许你没有看到这有什么用处。我建议你去看看强力剂。在doxygen中，在函数之前可以在注释中编写的任何文档也可以在函数内部编写。例如，这允许您继续“备注”部分，解释算法，以非常接近文字编程的方式交错代码和文档。一些代码片段受益匪浅。重构代码是好的，但我不认为从程序员那里拿走工具是实施良好编码实践的有用“功能”。FWIW我认为它不起作用，我现在维护的代码库的编写者没有说“哦，天哪，我不能注释局部变量，所以这意味着我现在要编写更好的代码”。另外，假设这是为了鼓励良好的编码风格，为什么局部变量Intellisense注释适用于C/C++而不适用于VS2013中的C？“我认为不应该存在此功能，因为它只会帮助编写过大的函数。”我认为它应该存在，除非你能重写我必须处理的30k+行后端代码。我们实际上记录这些变量是为了首先重构mega方法，而缺少这个功能无助于。。。