如何在Visual Studio的C#编码场景中为自研库添加自定义代码警告提示

我在未使用Endpoint Routing的情况下调用UseMvc()方法时，Visual Studio会在编码过程中显示警告消息。我已经清楚该警告的解决方法，但我想知道如何制作同类警告：我自行编写了一些类库，希望在其他开发者编码使用这些库时能提醒他们规范调用。

你要实现的这类编码阶段实时触发的IDE警告，有两种常用实现方式，可根据需求复杂度选择：

方案1：使用.NET内置ObsoleteAttribute特性（最简方案） #

这是无需额外开发的原生方案，直接给你不推荐随意调用的类、方法、属性附加该特性即可，可自定义警告提示，还能配置告警等级：

// 参数1：自定义警告提示内容
// 参数2：设为false为编译警告，设为true会直接抛出编译错误阻断项目生成
[Obsolete("该方法需配合XXX服务注册使用，直接调用会导致路由逻辑异常", false)]
public void YourCustomMethod()
{
    // 你的业务逻辑
}

附加后，调用方在Visual Studio等IDE中编码时就会实时看到下划线警告，编译项目时也会在输出面板同步显示该警告。

方案2：自定义Roslyn代码分析器（支持复杂规则判断） #

如果你的警告需要结合上下文判断（比如和UseMvc()的警告一样，需要判断用户是否开启了特定配置、是否满足前置调用条件才触发），可以基于Roslyn开发自定义代码分析器：

• 支持精准匹配代码上下文、项目配置、调用链路等复杂条件触发告警
• 可自定义警告编号、文档说明、甚至配套一键自动修复逻辑
• 开发完成后将分析器打包进你的类库NuGet包中，用户安装你的NuGet包后自动加载分析规则，无需额外配置

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