配置编译器警告

JetBrains Rider 包含可报告最重要的编译器警告的代码检视，以及相应的快速修复。为确保 JetBrains Rider 的代码检视结果与编译器输出及其他工具和分析器保持一致，编译器警告的严重性级别无法像 JetBrains Rider 专有检视那样从编辑器或通过 JetBrains Rider 设置进行配置。

相反，您可以使用其他方法来抑制编译器警告，具体方式如下：

配置方式	兼容性	粒度	用它来
.editorconfig	所有代码分析规则，并非所有编译器警告	文件／类型／全局	确保与 Roslyn 分析器兼容；更改规则的严重性级别
#pragma 指令	所有编译器警告和代码分析规则	代码块／文件	在本地抑制特定警告
.csproj 中的属性	所有编译器警告和代码分析规则	项目作用域	在构建级别抑制警告或将警告升级为错误
[SuppressMessage] 特性	所有编译器警告和代码分析规则	类型／成员	在本地作用域中抑制特定警告
GlobalSuppressions.cs	所有编译器警告和代码分析规则	程序集范围	在整个项目中抑制不可编辑或生成代码中的警告

使用 .editorconfig（推荐用于代码风格和现代分析器）

.editorconfig 文件是一种配置代码风格和诊断的便捷方式。它允许您以一致且项目范围的方式指定某些警告的严重性等级。

您可以使用如下格式的 EditorConfig 键来针对所有支持的警告进行配置：

dotnet_diagnostic.<ID>.severity = none | silent | suggestion | warning | error

例如：

dotnet_diagnostic.CS8618.severity = none

此方法适用于自 C# 8.0 起的编译器警告及 Roslyn 分析规则，包括由编译器自身触发的规则。例如：

与可空引用相关的警告（CS8xxx）。
平台兼容性警告（CS9xxx）。
某些文档或代码风格诊断（例如 CS1591）。

在代码中使用 #pragma 指令

您可以使用 #pragma 指令直接在代码中抑制特定警告。这适用于临时抑制或将警告范围限制到某一特定代码块。

若要抑制高亮显示的编译器警告，请按 Alt+Enter 并选择相应项。

使用 #pragma 进行的抑制如下所示：

            
        catch (Exception e)
        {
            Console.WriteLine("Caught exception {0}", e);
        }

#pragma warning disable CS1058 // A previous catch clause already catches all exceptions
        catch
#pragma warning restore CS1058 // A previous catch clause already catches all exceptions
        {
            Console.WriteLine("Exception fallback");
        }

        
  

此方法适用于所有编译器警告（CSxxxx ），甚至包括无法通过 .editorconfig 配置的警告。

在项目文件（.csproj）中配置警告

项目文件允许您在整个项目范围内配置警告行为。示例如下：示例包括：

抑制特定警告

                
<PropertyGroup>
    <NoWarn>CS8618;CS1591</NoWarn>
</PropertyGroup>

将所有警告视为错误

                
<PropertyGroup>
    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>

将特定警告视为错误与否

                
<PropertyGroup>
    <WarningsAsErrors>CS8618</WarningsAsErrors>
    <WarningsNotAsErrors>CS1591</WarningsNotAsErrors>
</PropertyGroup>

.csproj 文件中的配置适用于所有 CS 警告，并在构建输出行为方面覆盖 .editorconfig 设置。

使用 [SuppressMessage] 特性

[SuppressMessage] 可用于在特定类型或成员中抑制特定编译器警告和代码分析规则。当您希望以清晰、有范围且有文档记录的方式进行抑制时，它可以替代 #pragma。例如：

            
    [SuppressMessage("Compiler", "CS1058",
        Justification = "Intentional for testing")]
    static void Test()
    {
        try { }

        catch (Exception e)
        {
            Console.WriteLine("Caught exception {0}", e);
        }

        catch
        {
            Console.WriteLine("Exception fallback");
        }
    }

        
  

使用全局抑制文件（GlobalSuppressions.cs）

您可以使用全局抑制文件在整个项目中抑制任意编译器警告或 Roslyn 代码分析规则。使用特性来指定要抑制的警告。例如：

            
// GlobalSuppressions.cs

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage(
    "Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores",
    Justification = "Test methods require underscores for readability."
    Scope = "namespaceanddescendants", Target = "~N:Company.Product.Tests")]

最后修改日期： 2025年 9月 26日