禁用/修复 .Designer.cs 文件中的代码分析警告

Question

我正在广泛使用DataVisualization.Charting.Chart，并且大部分情况下它都在工作。但是，我一直在频繁地运行代码分析，并且已经处理了我自己的所有警告。但是，在使用图表的 *.Designer.cs 文件中大约有 30 个 CA2000（对象未沿所有异常路径放置）。 Designer 文件生成了几乎所有的图表代码，并且几乎所有的图表元素都实现了IDisposable。我在项目首选项中选中了“抑制生成代码的结果”，但它仍然可以。

有什么方法可以解决这个问题，无需手动创建图表对象，也无需禁用该类中其余代码的代码分析？有没有办法为所有 .Designer.cs 文件禁用它？或者，是否有解决方案通过让设计器代码负责处理来正确删除这些警告？

Answer 1

似乎有相当多的开发人员遇到这种情况时运气不佳，所以 +1 提出一个好问题！

一个可能的解决方案是编写一个覆盖 CA2000 并在设计器文件中检测到警告时抑制规则的方法，这是一个好的开始：

Writing Custom Code Analysis Rules in Visual Studio 2010

否则看到这个帖子末尾的 cmets，MSFT 工程师提到要记录一个 Connect 调用：http://blogs.msdn.com/b/codeanalysis/archive/2010/03/22/what-s-new-in-code-analysis-for-visual-studio-2010.aspx

Answer 2

我知道我迟到了，但我来了。

我猜这些警告都是针对InitializeComponent 方法中的代码发出的？如果是这样，那么您是否考虑过修改位于 Common7\IDE\ItemTemplates 文件夹中的模板文件？您可以在其中的方法上添加 GeneratedCode 属性。由于该属性将仅在其上设置，因此同一类中的所有其他代码仍将通过代码分析进行检查。

这是Form设计器文件的示例：

namespace $rootnamespace$
{
    partial class $safeitemrootname$
    {
        /// <summary>
        /// Required designer variable.
        /// </summary>
        private System.ComponentModel.IContainer components = null;

        /// <summary>
        /// Clean up any resources being used.
        /// </summary>
        /// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
        protected override void Dispose(bool disposing)
        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }

        #region Windows Form Designer generated code

        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        [System.CodeDom.Compiler.GeneratedCode("Windows Form Designer generated code", "1.0.0.0"), System.Diagnostics.DebuggerNonUserCode()]
        private void InitializeComponent()
        {
            this.components = new System.ComponentModel.Container();
            this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
            this.Text = "$safeitemrootname$";
        }

        #endregion
    }
}

Answer 3

只需将 [SuppressMessage("Microsoft.Usage", "CA2213:DisposableFieldsShouldBeDisposed", MessageId = "..."] 添加到 *.Designer.cs 文件中的 Dispose 方法即可。

我刚刚做了，我发现 VS 2012 足够聪明，即使在设计器中发生更改时重写文件时也能将其保留在那里。

Answer 4

您是否尝试在项目的代码分析属性页面中将“抑制生成代码的结果”属性值切换为 true？此选项是忽略生成代码中的问题的标准机制。

也就是说，生成的代码是会被执行的代码，因此忽略它的违规行为不一定是个好主意。鉴于 CA2000 的“噪音”，您不妨考虑禁用该规则。