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

Question

Есть

///<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: хорошо, мы выяснили, что это работает как обычно, если вы прокомментируете в своем классе, но ВНЕ метод или функцию !!

Есть ли способ документировать / комментировать внутри метода?

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

Answer 1

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

Answer 2

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

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

Answer 3

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

Answer 4

Редактировать: похоже, поддерживается только для JavaScript.

Начиная с Visual Studio 2012, вы можете добавить эту документацию, используя элемент .

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

Answer 5

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

Answer 6

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