C# 中注释///

是什么意思

平时自己写代码的时候，注释都是用两个斜杠这么写的//
但是我在实际工作时，看到别人写的函数接口前面都是这么写注释的：

/// <summary>
/// 这是一个函数的例子
/// </summary>
void Funtion()
{
 ...
}

经过查找资料，我发现原来写注释的方法并不好，如果我用这种方式写注释，会更方便的在使用函数的时候看到对应的注释。
举个例子，我在Unity里创建了两个C#写的脚本，代码如下：

public class TestOne : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        TestTwo.Function1();
        TestTwo.Function2();  
    }
}

public class TestTwo : MonoBehaviour
{
    /// <summary>
    /// This is Function 1
    /// </summary>
    public static void Function1()
    {

    }

    // This is Function 2
    public static void Function2()
    {

    }
}

在TestOne脚本中，当我们的鼠标放在调用的Function1和Function2函数的时候，提示图如下：
Function1直接显示了注释说明

而Function2则什么也没有，需要按F12进入函数进行注释查看：

所以，用/// <summary>写注释的方法更好用，尤其是用于写库文件的时候，因为这种文件我们看不到源码，只有这种的注释，能够让调用者看到，同时，在写C#函数的注释的时候，能用这种写法，就用这种写法，既显得专业，又好用。

如果想要两行注释，可以这么写：

 /// <summary> 
 /// <para>This is Function1.1</para> 
 /// <para>This is Function1.2</para> 
 /// </summary> 
 public static void Function1()
 {
 }

如下图所示，不过多了一行空行，好像是VS2017版本后会出现的问题，如何消除这一空行，还没看到具体的方法。

其实这些小参数都是类似PHP这种的XML语言，如果要给函数的参数提供注释，再加个返回值的注释，写法如下：

 /// <summary> 
 /// </summary> 
 /// <param name="a" >函数需要输入的第一个int变量.</param>
 /// <param name="b" >函数需要输入的第二个int变量.</param>
 /// <returns>Returns zero.</returns>
 public static int Function1(int a, int b)
 {
     return 0;
 }

结果如图所示：

转载自原文链接, 如需删除请联系管理员。

原文链接：C# 中注释///