Visual Studio 2022社区版：悬停显示局部变量注释可行吗？

在Visual Studio 2022社区版中，字段、方法、类等成员的XML注释能在鼠标悬停时正常显示工具提示，但局部变量的注释无论用哪种写法都无法显示。测试代码如下：

class Test
{
    /// <summary>
    /// A summary
    /// </summary>
    public int A;

    public Test()
    {
        // B summary
        int B;

        int C; // C summary

        /// <summary>
        /// D summary
        /// </summary>
        int D;

        this.A = 1;
        B = 2;
        C = 3;
        D = 4;

        if (B == C || C == D)
        {

        }
    }
}

解决方案 #

Visual Studio原生并不支持局部变量的注释在悬停工具提示中显示，想要实现这个功能可以通过以下方式：

• 安装第三方插件：比如ReSharper、Visual Assist这类工具，它们能够识别局部变量的各类注释（包括你测试的三种写法），并在鼠标悬停时展示对应的提示内容。
• 改用代码注释规范：如果不想依赖插件，可以在局部变量定义附近用//注释说明，虽然悬停不显示，但代码可读性依然有保障；或者通过清晰的变量命名直接体现用途，减少对悬停提示的依赖。

内容的提问来源于stack exchange，提问作者Dang-gun Roleeyas