在Visual Studio中//和///有什么區別？

Question

當我評論時，Stylecop告訴我使用///代替//。 這兩者的語義差異是什么？何時應該使用哪一個？

Answer 1

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

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

這將告訴Visual Studio Bob類的摘要，然后它將顯示在您的代碼完成框中。

Answer 2

通過進一步的Stylecop規則自己找到它：

在評論時使用//

在記錄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恰好選擇它來進行評論。 遵循沙堡等自動代碼文檔工具的這些規則通常很有幫助。

例如， doxygen對C ++代碼的注釋風格完全不同。 所以它主要是為了一致性和標准