当我输入///
时,Visual Studio会向我显示一些这样的参数:
/// <summary>
///
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
C#中的//
和///
之间有什么区别?
答案 0 :(得分:8)
有很大的不同。
首先:将显示XML评论 tooltips and auto complete。 尝试编写XML注释,并在编写函数时注意在键入函数时弹出的XML注释中的内容。
第二次:您可以轻松使用tools to generate complete documentation。
答案 1 :(得分:1)
他们都是不会被编译的评论。在Visual Studio中键入///时,它将为您生成这些注释。您可以将这些XML注释用作文档。
在第一个//
之后输入的任何内容都被视为注释(不是编译代码)。您的IDE(Visual Studio)使用这些特殊的XML注释来执行诸如通过Intellisense显示有关方法/类型/等的详细信息。
答案 2 :(得分:1)
//注释是正常注释,而///注释通常称为xml注释。它们可用于为您的课程制作详细的帮助文档。
答案 3 :(得分:1)
使用///时,它将根据函数头生成注释(如您的示例所示),然后在其他地方使用该函数时可以引用该注释。例如,如果我有以下内容:
///<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);
我可以将鼠标放在“功能”上,然后会弹出一个小窗口,其中包含一个很酷的东西,并解释它需要一个很酷的数字并返回一个寒冷的数字。这也适用于重载,因此您可以滚动每个重载标题并对所有重载标题放置不同的摘要/变量说明。
答案 4 :(得分:0)
单行评论(//):
示例:强>
main()
{
cout<<"Hello world"; //'cout' is used for printing the output, it prints Hello world
}
在上面的示例中,使用//注释,描述&#39; cout&#39;言。
XML文档评论(///):
示例:强>
///<summary>
/// Example 1
/// Using <summary> rag
///</summary>
详细信息请点击以下链接:
C#.NET Difference between // comments, /* */ comments and /// comments