如何在调用C#枚举的ToString方法时触发编译器警告？

我们有部分代码会根据环境名称等条件为基础设施构件命名，以下是简化示例：

enum AppEnvironment
{
    Dev,
    Staging,
    Production
}

static class AppEnvironmentExtensions
{
    static string AsString(this AppEnvironment env) => env switch
    {
        AppEnvironment.Dev => "dev",
        AppEnvironment.Staging => "stage",
        AppEnvironment.Production => "prod",
        _ => throw new InvalidOperationException("Invalid environment")
    };
}

void BuildConstruct(string appName, AppEnvironment env)
{
    string constructName = $"{env}-{appName}"; // ← 错误：意外调用默认ToString()
    // 执行基础设施相关操作
}

问题核心：开发者容易在字符串插值、String.Format等场景意外调用AppEnvironment枚举的默认ToString()方法，而非自定义的AsString()扩展方法，导致难以排查的故障。需要实现设计时解决方案：当代码调用该枚举的ToString()时（包括间接调用场景），显示编译器警告，让开发者明确选择改用AsString()或通过#pragma warning disable允许调用。

可以通过Roslyn分析器轻松实现这个需求，Roslyn分析器本身就是为这类自定义静态代码检查场景设计的，具体实现思路如下：

• 定位目标枚举类型：在分析过程中，先识别代码中所有AppEnvironment类型的符号引用，确保只针对该枚举做检查，不会影响其他类型。
• 覆盖所有调用场景：
  1. 直接调用：检测形如env.ToString()的显式调用，通过语法节点匹配InvocationExpressionSyntax，并验证目标方法是AppEnvironment的ToString方法。
  2. 间接调用：
     • 字符串插值（如$"{env}"）：Roslyn会将其编译为String.Format调用，其中枚举参数会被隐式转换为object并触发ToString()，需要分析插值表达式中的参数类型是否为AppEnvironment。
     • String.Format、Console.WriteLine等接受object参数的方法：检查传入的参数是否为AppEnvironment实例，这类场景下底层会调用枚举的ToString()。
• 生成自定义警告：一旦检测到上述场景，抛出自定义的编译器警告（可自定义警告ID和提示信息，比如“请使用AppEnvironment.AsString()方法代替默认ToString()”），开发者可以选择修复代码，或者通过#pragma warning disable临时禁用该警告。
• 可选：添加代码修复：还可以配套实现代码修复功能，自动将$"{env}"替换为$"{env.AsString()}"，或者将直接的ToString()调用替换为AsString()，进一步提升开发效率。

这类分析属于Roslyn的常规应用场景，主要依赖语法分析和符号分析，不需要复杂的数据流计算，官方文档和社区有大量示例参考，实现成本低且效果可靠。

内容的提问来源于stack exchange，提问作者Jacob Stamm