如何在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>(); 

編輯：好吧，我們已經發現了，它的工作原理像往常一樣，只要ü評論在您的類，但外的方法或功能！

任何方式也可以在方法中記錄/評論嗎？

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

似乎在Visual Studio 2010中工作得非常好。我將List定義爲一個私有字段，在我的MainForm類中有註釋。

雖然它們在函數中定義的局部變量不起作用。

Answer 2

與爲類和方法編寫摘要的方法同樣適用於變量。

Answer 3

您可以添加這樣XML documentation評論任何類成員，而不是一個成員（方法，屬性等）內。

Answer 4

據我所知，智能感知添加註釋不會爲函數內聲明的局部變量工作。如果你想讓你的本地列表成爲這個類的一個實例變量，你可以做到這一點。

Answer 5

正如其他人所說，你無法獲得本地變種的智能感知。但是：如果你的函數太大以至於「常規」註釋不夠近，無法在你使用var的地方讀取，那麼正確的修復就是重構函數 - 將其分解爲多個，更小的方法，更少的變量。我認爲這個功能應該是的存在，因爲它只會幫助編寫過大的函數。

Answer 6

編輯：它看起來像<var>只支持JavaScript。

從Visual Studio 2012開始，您可以使用<var>元素添加此文檔。

下面是關於這微軟的文檔：
https://msdn.microsoft.com/en-us/library/hh542722(v=vs.110).aspx