2011-03-14 89 views
27

從Eclipse我用,當我開始輸入一個類或方法的評論,參數,返回類型和異常是自動生成的。但在VisualStudio 2010中,我找不到像這樣的東西。任何提示如何實現?如何在Visual Studio 2010和C#中自動生成評論?

+3

請注意,在C#中,「exceptions」通常不會被註釋,因爲它們沒有像在Java中那樣在方法級定義...... – 2011-03-14 16:22:37

回答

85

我知道這樣做的唯一方法就是在你的方法上面的行上輸入「///」,它會根據方法生成一個評論模板。

+3

這會教我在編寫方法之前編寫我的註釋,所以我專注於我打算做什麼的方法! – 2011-03-14 17:15:30

+3

但那不包括例外。如果它能夠創建所有異常的摘要並且我們可以刪除我們捕獲的異常,那將是非常好的。通過手動指定它們,我經常忘記評論其中的一些,特別是在其他人使用的庫中。 – 2015-03-17 08:50:14

1

嘗試在方法前面輸入「///」一行。告訴我,如果這是你在找什麼。

5

使用「///」而不是「//」作爲註釋。例如,下面的評論是自動生成的由剛開始輸入「///」:

/// <summary> 
/// </summary> 
/// <param name="terms"></param> 
public TVec(IEnumerable<Term> terms) 
{ 
} 
+0

'''任何人都想在視覺基礎上做到這一點:) – user2728841 2016-10-31 09:35:26

11

GhostDoc是一個免費的擴展,將做到這一點。只需在方法中的任意位置點擊(默認情況下)Ctrl + D,它將添加XML文檔註釋並填充默認值(儘管它們通常應該被修改/展開)。

+2

只需要注意:僅限個人使用。如果你關心;-) – schoetbi 2015-02-12 10:01:56