Visual Studio中//和///有什麼區別？

Question

當我評論時，Stylecop告訴我使用///而不是/ //。這兩者的語義差異是什麼？我應該在什麼時候使用哪一種？

Answer 1

//表示自己的個人意見，其中///表示可以包含特殊數據的註釋，例如標記的解釋由Visual Studio - 樣：

/// <summary> 
/// This class does something. 
/// </summary> 
class Bob { 
    ... 
} 

這將告訴Visual Studio中的鮑勃類的彙總，然後將在你的代碼完成框出現。

Answer 2

發現它自己正在經歷進一步的規則StyleCop的同時：

使用// commentin

使用時///記錄爲XML文件頭時

Answer 3

三重斜線爲您提供了參數和其他功能自動生成的模板會自動爲你有

/// <summary> 
/// Here is your comment 
/// </summary> 
/// <param name="sender">parameter generated automatically</param> 
/// <param name="e">as above</param> 
void BindableCollection_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e) 

這種方法意味着如NDoc的工具就可以拖網源創建的文檔自動的文件。雙斜槓不會削減它....

Answer 4

沒有語義差異，它只是一種編碼或評論的風格。 .NET恰好選擇了這個評論。遵循這些自動代碼文檔工具（如sandcastle）的這些規則通常很有幫助。

例如Doxygen對C++代碼有完全不同的評論風格。所以它主要是爲了一致性和標準