如何编写注释/文档在VS 2010中的变量/场/列表？ [英] How to write comments / documentation for variables / fields / lists in VS 2010?

问题描述

有

  ///＆LT;总结＆gt;
///这是总结了一些类或方法
///＆LT; /总结＆gt;
 

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

我使用Visual Studio 2010，当我悬停在一些名单，财产或什么都我想看到某种摘要（中那个小提示），我已经写了具体的东西。

  ///＆LT; D​​OC＆GT;
///始终使用该列表！
名单＆LT;字符串＆GT;啤酒=新的名单，其中，字符串＆GT;（）;
 

编辑：好的，我们已经发现了，它的工作原理像往常一样在你的类，但外面的方法或函数!!长ü评论

任何方式中的一个方法太文档/评论？

 公共类BeerForall
{
    ///＆LT;总结＆gt;
    ///它在这里工作
    ///＆LT; /总结＆gt;
    公开名单＆LT;字符串＆GT;啤酒=新的名单，其中，串＆GT;（）;

    公共字符串giveBeer（）
    {
        ///不工作，你无法发表评论
        ///＆LT;总结＆gt;
        ///试验测试，不工作
        ///＆LT; /总结＆gt;
        名单＆LT;字符串＆GT; moreBeer =新的名单，其中，串＆GT;（）;

        返回啤酒;
    }
}
 

解决方案

似乎工作在Visual Studio 2010中我定义了一个列表，与在我MainForm类评论的私人领域完全正常的。

他们不会为局部变量的虽然在功能定义的工作。

There is

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

documentation for classes or methods. But how to write this for simple variables or lists?

I use Visual Studio 2010 and when i hover over some list, property or what ever i would like to see some kind of summary (in that little tooltip) i have written to that specific thing.

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

edit: ok, we have found out, that it works as usual as long u comment in your class but OUTSIDE a method or a function!!

Any way to document/comment within a method too?

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

解决方案

Seems to work perfectly fine in Visual Studio 2010. I defined a List as a private field with a comment inside my MainForm class.

They won't work for local variables defined within functions though.

这篇关于如何编写注释/文档在VS 2010中的变量/场/列表？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！