21

有

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

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

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

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

6 回答 6

16

正如其他人所提到的，您无法为本地变量获取 IntelliSense。但是：如果您的函数太大以至于“常规”注释不够接近以至于无法在您使用 var 的位置附近阅读，那么正确的解决方法是重构函数 - 将其分解为多个更小的方法，变量更少。我认为这个特性不应该存在，因为它只是为了方便编写过大的函数。

于 2011-10-31T17:13:33.993 回答
13

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

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

在此处输入图像描述

于 2011-10-31T13:08:37.497 回答
6

据我所知，为智能感知添加注释不适用于函数内声明的局部变量。如果您要使本地列表成为该类的实例变量，您将能够做到这一点。

于 2011-10-31T13:12:34.873 回答
0

与为类和方法编写摘要相同的方式适用于变量。

于 2011-10-31T13:03:26.047 回答
0

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

于 2011-10-31T13:03:28.497 回答
0

编辑：看起来 <var> 仅支持 JavaScript。

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

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

于 2016-04-26T21:34:27.117 回答