抑制生成的 C# 代码的警告

Question

我已经为我的 VS 项目打开了“将警告视为错误”，这意味着我会收到缺少文档的错误（对于这个特定项目来说是一个很好的提醒）。

但是，部分代码是由自定义工具生成的，该工具不会插入 xml 文档，因此我希望仅忽略生成的代码（而不是整个项目）缺少的 xml 文档。我对生成的实际文件没有影响，并且无法真正在文件中插入任何内容（因为它经常由工具重新生成），因此我寻找生成文件之外存在的内容（生成的类是部分的，如果有帮助的话）

Answer 1

避免生成的代码出现警告或代码分析错误的最佳方法是使用 GenelatedCodeAttribute 并使代码文件以 *. generated.cs 模式结尾。

如果您的代码文件也有文件头，您应该有这些标签：

//----------------------
// <auto-generated>
//     Tool description
// </auto-generated>
//----------------------

这不是强制性的，但如果您有代码文件头，这是一个很好的做法。

这样，FxCop 和其他工具（如 StyleCop）将不再分析您的代码。

异常的是您的代码生成工具没有使用上述属性来装饰您的代码元素。尝试查看您的工具设置中是否有启用选项或联系开发团队。

---

编辑：
生成的类是否是部分类，并且实际的类名称和编号是否经常更改？因为如果生成的代码内容移动量不大，您可以做的就是创建另一个代码文件，并声明生成的分部类，并用 GenerationCodeAttribute 来装饰它们。有一次它救了我的命（还有我的时间！）。

Answer 2

编辑：请参阅表明这不适用于 C# 4 的注释。我不清楚它是否适用于早期版本的编译器。 C# 4 规范已经非常清楚地说明了这一点。第 2.5.8.1 节规定：

#pragma warning restore 指令将所有或给定的一组警告恢复到编译单元开始时有效的状态。请注意，如果从外部禁用了特定警告，#pragma warning recovery（无论是针对所有警告还是针对指定警告）将不会重新启用该警告。

Jeff 在博客文章中提供了解决方法 - 基本上是重新处理自动生成的代码作为构建的一部分。

---

正如 Tom 所说，您可以向整个项目添加“忽略”（构建/抑制警告 - 输入 1591 作为警告编号） - 但随后您可以在每个项目的顶部自行恢复警告。你的非生成文件：

#pragma warning restore 1591

它非常丑陋，但它有效（我刚刚测试过）。

Answer 3

您能做的最好的事情就是抑制包含生成代码的项目中的特定警告。您可以在“构建”选项卡上的“项目属性”中执行此操作。这并不理想，但除了将编译指示放入生成的代码中之外，它是您能做的最好的事情。