如何仅在生成的代码中禁用编译器警告而不编辑文件

Question

我有一些生成的代码有很多编译器警告。我想在生成的文件中禁用它们，但将这些警告保留在项目的其余部分中，以便可以修复它们。我使用的是 Visual Studio 2019 Community Edition，生成的文件来自实体框架和其他 NuGet 包。

我想在不更改文件的情况下执行此操作，因此如果重新生成它们，我将不会收到警告。我也不想在项目范围内禁用警告，因为它们通常是有用的警告。我也不想编辑 NuGet 包，因为这要么需要在有新版本可用时不升级它们，要么可能必须对新版本进行更改。

我已经读了很多书，但显然发布链接“太多”，所以我删除了它们。如果您想查看它们，请查看编辑历史记录。

有问题的文件是Reference.cs连接服务的文件。它的命名空间为Proxy.ProvisioningService，并且这个文件包含几十个类。我还有几个实体框架迁移文件，它们在完全不同的解决方案中存在相同的问题。

我有一个 GlobalSuppressions.cs 文件，我想将 CS1591 （专门）添加到其中，但我当前的条目不起作用。其他条目适用于其他警告，我已经尝试了以下代码的变体来工作，包括尝试匹配其他条目的格式，但到目前为止没有任何效果。我已经将“Build”从“Compile”更改为“Build”，删除了MessageId，更改Scope为“module”，“Assembly”和“namespaceanddescendants”，并且我尝试了几种不同的方法来设置Target.

[assembly: SuppressMessage("Build", "CS1591:Missing XML comment for publicly visible type or member", Justification = "Generated code", MessageId = "CS1591", Scope = "namespaceanddescendants", Target = "Proxy.ProvisioningService")]

在其中一个场外链接中，它建议我右键单击该错误，转到Suppress -> In Suppression File，但这不是列出的选项。这是我无法在GlobalSuppressions.cs文件中执行此操作的线索吗？

我尝试让 Visual Studio 2019 Community Edition 自动抑制菜单项发出的警告Analyze -> Build And Suppress Active Issues -> For Project，但这只是向文件添加了一堆#pragma指令，如果重新生成文件，则必须替换这些指令，这是我想避免的。

链接的答案之一建议编写一个脚本来#pragma在编译时添加指令，但该脚本对我来说似乎是一种黑客行为。我宁愿根本不编辑生成的代码。

我也不想将其放在该Project -> Properties -> Build -> Suppress Warnings部分中，因为我希望手写代码仍然抛出这些警告。

另一个 SE/SO 答案建议使用该GeneratedCodeAttribute属性来防止生成的文件发出警告。不幸的是，我的文件已经有这个并且它仍然抛出警告。

另一个建议是关闭这些生成文件的警告：

抑制项目中生成的代码的警告

1. 在“解决方案资源管理器”中右键单击该项目，然后单击“属性”。

2. 选择代码分析选项卡。

3. 选中抑制生成代码的结果复选框。

不幸的是，该选项已被选中，并且不会抑制 CS1591 警告。

所以我的实际问题是：

如何从生成的代码文件中抑制警告，特别是 CS1591，而不对其进行编辑，并且在整个项目中不抑制警告？

Answer 1

您说您考虑使用脚本来更新文件以添加#pragma hack，但我想不出其他解决方案。

我认为您可以通过在 .csproj 文件中添加类似的内容，使用 MSBuild 任务轻松完成此操作：

<Target Name="DisableWarnings" BeforeTargets="CoreCompile">
    <ItemGroup>
        <AutoGeneratedFiles Include="**/*.Designer.cs" />
    </ItemGroup>
    <WriteLinesToFile File="%(AutoGeneratedFiles.FullPath)"
        Condition="!$([System.IO.File]::ReadAllText(%(AutoGeneratedFiles.FullPath)).StartsWith(&quot;#pragma warning&quot;))"
        Lines="$([System.String]::Concat(&quot;#pragma warning disable 1591&quot;,$([System.IO.File]::ReadAllText(%(AutoGeneratedFiles.FullPath))),&quot;#pragma warning restore 1591&quot;))"
        Overwrite="true"
        Encoding="Unicode" />
</Target>

Answer 2

SuppressMessage属性仅适用于代码分析警告。其摘要如下：

抑制特定代码分析规则违规的报告，从而允许对单个代码工件进行多次抑制。不适用于编译器诊断。

如果存在标识生成代码的文件名模式，则可以使用EditorConfig在生成的代码中抑制编译器警告。例如，这就是我在生成的代码中禁用使用过时代码元素的警告的方法——我仍然需要使用#pragma 抑制手动编写的代码中的警告。

[*.generated.cs]
dotnet_diagnostic.CS0612.severity = none
dotnet_diagnostic.CS0618.severity = none