利用SuppressMessage来阻止FxCop进行代码分析时报出的警告

    最近用.Net Compact Framwork 3.5 (C#)做的一个Windows Mobile(6.5)的项目,客户方面对代码质量要求比较严格，本以为代码上没什么大问题,没想到利用FxCop一分析,竟然报出400多个改进建议。

    FxCop还是第一次使用，实际上Visual Studio.net 2008已经集成了代码分析的功能。右击工程->属性->CodeAnlysis，见下图。

  

   选择了“Enable Code Analysis on Build”后，编译程序的同时会自动进行代码检查，对于不符合规范的将以Warning的形式报告出来。当然，对于其提出的规范不一定在实际项目中条条都必须遵守，有些经Review后认为不比必要遵守规则的Warning我们可以右击选“SuppressMessage”让它不再显示。

   对于FxCop也是一样，在违反规则的相关代码出我们标记相关的SuppressMessageAttribute后，FxCop将不再报告该冲突。例如：

[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter")]
public static T CreateForm<T>(bool showAfterCreated ) where T : BaseForm, new()
{
      return CreateForm<T>(showAfterCreated, true);
}

   但是，要想上述标记起作用，还得在项目属性的Build选项卡的“Conditional compilation symbols”里定义“CODE_ANALYSIS”，如图：

  

   在AssemblyInfo.cs里也可以定义SuppressMessage，如：

// Below attribute is to suppress FxCop warning "CA2232 : Microsoft.Usage : Add STAThreadAttribute to assembly"
// as Device app does not support STA thread.
[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2232:MarkWindowsFormsEntryPointsWithStaThread")]

   如果想在Project级别SuppressMessage，可以写在“GlobalSuppressions.cs”里。

 

参考：http://blogs.msdn.com/fxcop/archive/2006/03/23/faq-why-does-fxcop-ignore-my-in-code-suppressmessageattribute-suppressions-david-kean.aspx