c# 中 // 和 /// 之间的区别

Question

当我输入/// ，Visual Studio 会向我显示一些如下参数：

/// <summary>
/// 
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>

C# 中的//和///什么区别？

Answer 1

有很大的不同。

第一：XML 注释将显示在工具提示和自动完成上。 尝试编写 XML 注释，并在编写函数时注意在键入函数时在 XML 注释中所写的内容如何弹出。

第二：可以轻松地使用工具生成完整的文档。

另见MSDN上的官方解释

Answer 2

它们都是不会被编译的注释。 当您在 Visual Studio 中键入 /// 时，它会为您生成这些注释。 您可以将这些 XML 注释用作文档。

在第一个//之后键入的任何内容都被视为注释（不是编译代码）。 您的 IDE（即 Visual Studio）使用这些特殊的 XML 注释来执行诸如通过 Intellisense 显示有关方法/类型/等的详细信息的操作。

Answer 3

// 注释是普通注释，而 /// 注释通常称为 xml 注释。 它们可用于为您的课程制作详细的帮助文档。

http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

Answer 4

当您使用 /// 时，它将根据函数头生成注释（如您在示例中所见），然后在您在其他地方使用该函数时可以引用这些注释。 例如，如果我有以下内容：

///<summary>
///Does cool things
///</summary>
///<param name="x">A cool number</param>
//There's another for return, I don't remember the exact format:
///<return>A frigid number</return>
int function(int x)

如果我要在其他地方写这个：

int a = function(b);

我可以将鼠标放在“函数”上，然后会弹出一个小窗口，其中有一个总结，说明它做了很酷的事情，并解释说它需要一个很酷的数字并返回一个寒冷的数字。 这也适用于重载，因此您可以滚动浏览每个重载标题并在所有标题上放置不同的摘要/变量解释。

Answer 5

1. 单行注释 (//)：

   • 它可以以' // '开头
   • 它是单行注释。

示例：

main()
{
   cout<<"Hello world";   //'cout' is used for printing the output, it prints Hello world
}

在上面的例子中，用//注释，描述了'cout'语句的使用。

2. XML 文档注释 (///)：

   • 它用于 XML 文档。
   • 它提供有关代码元素（例如函数、字段和变量）的信息。

示例：

///<summary>
///   Example 1
///   Using <summary> rag
///</summary>

有关详细信息，请访问以下链接：

C#.NET // 注释、/* */ 注释和 /// 注释之间的区别