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++代码有完全不同的评论风格。所以它主要是为了一致性和标准