如何为C#方法添加描述？以Unity的StartFade方法为例

要让IDE在调用StartFade时显示功能描述和参数说明，直接给方法添加XML文档注释即可，具体写法如下：

/// <summary>
/// 启动CanvasGroup的淡入淡出动画
/// </summary>
/// <param name="isIn">控制淡入/淡出：传入true为淡入，false为淡出</param>
/// <param name="autoSwitch">是否允许自动切换动画方向：若当前已有相反方向的动画在执行，会先停止原有动画再启动新的动画</param>
public void StartFade(bool isIn, bool autoSwitch)
{
    if (canvasGroup != null)
    {
        if (_currentRoutine != null)
        {
            if (_currentDirection != isIn)
            {
                StopCoroutine(_currentRoutine);

                _currentRoutine = StartCoroutine(Fade(canvasGroup, isIn, autoSwitch));
            }
        }
        else
        {
            _currentRoutine = StartCoroutine(Fade(canvasGroup, isIn, autoSwitch));
        }
    }
}

添加完成后，当你在其他脚本中输入StartFade(时，Visual Studio或Rider这类IDE会自动弹出提示框，展示你写的方法功能描述和每个参数的含义，不再只显示方法签名。

注：IDE默认已开启智能提示功能，一般无需额外设置即可生效。

内容的提问来源于stack exchange，提问作者Daniel Lip