c# - 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 恰好选择了它作为评论。对于像sandcastle这样的自动代码文档工具，遵循这些规则通常会有所帮助。

例如，doxygen对 C++ 代码有完全不同的注释风格。所以主要是为了一致性和标准