Как написать комментарии/документацию для переменных/полей/списков в VS 2010?

Существует

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

для классов или методов. Но как написать это для простых переменных или списков?

Я использую Visual Studio 2010, и когда я наводил курсор на некоторый список, свойство или то, что когда-либо я хотел бы видеть какое-то резюме (в этой маленькой подсказке), я написал эту конкретную вещь.

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

edit: ok, мы выяснили, что он работает как обычно, так как длинный комментарий u в вашем классе, но 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";
    }
}

Ответы

Ответ 1

Кажется, отлично работает в Visual Studio 2010. Я определил List как приватное поле с комментарием внутри моего класса MainForm.

Они не будут работать для локальных переменных , определенных внутри функций.

enter image description here

Ответ 2

Как уже упоминалось, вы не можете получить IntelliSense для локальных варов. Однако: если ваша функция настолько велика, что "обычный" комментарий недостаточно близко, чтобы читать рядом с местом, где вы используете var, то правильным решением является рефакторинг функции - разбить его на несколько, более мелких методов, с меньшим количеством варов. Я не думаю, что эта функция должна существовать, поскольку она будет служить только для облегчения написания чрезмерно больших функций.

Ответ 3

Насколько я знаю, добавление комментариев для intellisense не будет работать для локальных переменных, объявленных внутри функций. Если бы вы сделали свой локальный список переменной экземпляра класса, вы могли бы это сделать.

Ответ 4

Точно так же, как вы пишете сводки для классов и методов для переменных.

Ответ 5

Вы можете добавить такую ​​документацию по XML к любому члену class, а не внутри члена (метод, свойство, и т.д.).

Ответ 6

Изменить: он выглядит как <var> поддерживается только для JavaScript.

С Visual Studio 2012 вы можете добавить эту документацию с помощью <var> элемент.

Здесь документация Microsoft на нем:
https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx