如何在VS 2010中为变量/字段/列表编写注释/文档?
有
/// ///This is summary for some class or method ///
类或方法的文档。 但是如何为简单的变量或列表编写这个?
我使用Visual Studio 2010,当我将鼠标hover在一些列表,属性或者我希望看到的某种摘要(在那个小工具提示中)时,我已经写过那个特定的东西。
/// ///always use this list! List beer = new List();
编辑:好的,我们已经发现,它像往常一样在您的class级中发表评论但是OUTSIDE方法或function!!
有什么办法在方法中记录/评论吗?
public class BeerForall { /// /// it works here /// public List beer = new List(); public String giveBeer() { /// is not working, u can not comment /// /// test test, not working /// List moreBeer = new List(); return "beer"; } }
似乎在Visual Studio 2010中完美运行。我将List定义为私有字段,在我的MainForm类中有注释。
但它们不适用于函数中定义的局部变量。
正如其他人提到的那样,您无法获得本地变量的IntelliSense。 但是:如果你的函数太大,以至于“常规”注释不足以在你使用var的地方附近阅读,那么正确的修复是重构函数 – 将其分解为多个较小的方法,vars较少。 我不认为这个function应该存在,因为它只会有助于编写过大的function。
据我所知,为intellisense添加注释不适用于在函数内声明的局部变量。 如果要使本地列表成为类的实例变量,则可以执行此操作。
与编写类和方法的摘要一样,为变量工作。
您可以将此类XML文档注释添加到任何类成员,而不是成员(方法,属性等)中。
编辑:看起来只有JavaScript支持。
从Visual Studio 2012开始,您可以使用元素添加此文档。
这是微软的文档:
https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx