FxCop on Marko Apfel

@Microsoft: please provide universal and professional concepts

Sun, 20 Nov 2011 11:35:00 +0100

Why such constructs are included in the .csproj-Files?

<CodeAnalysisRuleSetDirectories>;c:\Program Files (x86)\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\\Rule Sets</CodeAnalysisRuleSetDirectories>

<CodeAnalysisRuleDirectories>;c:\Program Files (x86)\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\FxCop\\Rules</CodeAnalysisRuleDirectories>

So it every projects needs some manual steps to clean the project file so the solution could be build on a continuous integration server. That annoying!

Suppressing FxCop/Code Analysis warnings in Config.Designer.cs of Esri Addins

Wed, 11 May 2011 13:35:00 +0200

Addins in ArcGIS Desktop 10 uses tool generated code of the Config.esriaddinx file.

Have a look at the properties you will see this tool – named ArcGISAddInHostGenerator.

Searching the new FxCop-Release (10.0)

Mon, 05 Jul 2010 14:45:00 +0200

Today my FxCop-GUI stated, that a new release is available – but the link to this release is broken.

After googling a little bit i realized, that the new release of FxCop ist actually only included in “Windows SDK for Windows 7.1”.

My own set of SuppressMessage-lines

Mon, 05 Jul 2010 10:35:00 +0200

StyleCop issues

inheritedoc-comment

Using -comment is not recognized by StyleCop. So this needs a suppression:

// <inheritdoc />
[SuppressMessage(
 "Microsoft.StyleCop.CSharp.DocumentationRules",
 "SA1604:ElementDocumentationMustHaveSummary",
 Justification = "InheritDoc")]

FxCop issues

Too few namespaces

[module: SuppressMessage(
 "Microsoft.Design",
 "CA1020:AvoidNamespacesWithFewTypes",
 Scope = "namespace",
 Target = "EsriDE.Core.Service.Logging",
 Justification = "We want to have this namespace, but do not have enough classes to go in it right now to satisfy the rule.")]

ReSharper only supports non static test methods

[SuppressMessage(
 "Microsoft.Performance",
 "CA1822:MarkMembersAsStatic",
 Justification = "ReSharper could not handle static test methods.")]

No strong name

[assembly: SuppressMessage(
 "Microsoft.Design",
 "CA2210:AssembliesShouldHaveValidStrongNames",
 Justification = "Strong name is not needed for this.")]

Catching general exception

[SuppressMessage(
 "Microsoft.Design",
 "CA1031:DoNotCatchGeneralExceptionTypes",
 Justification = "We do not know which exceptions could be thrown.")]

Justification for samples and fixtures

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "For fixtures this is OK.")]

Setter but no Getter (for example in IoC or NHibernate-context)

[SuppressMessage(
 "Microsoft.Usage",
 "CA2227:CollectionPropertiesShouldBeReadOnly",
 Justification = "Setter is needed for nhibernate, otherwise a NHibernate.PropertyNotFoundException will be thrown.")]

[SuppressMessage(
 "Microsoft.Xyz",
 "CAxyz:XYZ",
 Justification = "We only need a setter for setter injection.")]

Instantiation with IoC

[SuppressMessage(
 "Microsoft.Performance",
 "CA1811:AvoidUncalledPrivateCode",
 Justification = "We need this for unit tests.")]

[SuppressMessage(
 "Microsoft.Performance",
 "CA1812:AvoidUninstantiatedInternalClasses",
 Justification = "Class would be instantiated by IoC framework.")]

Incorrect naming

[SuppressMessage(
 "Microsoft.StyleCop.CSharp.NamingRules",
 "SA1310:FieldNamesMustNotContainUnderscore",
 Justification = "Windows message constants are commonly named as WM\_xxxxx")]

Incorrect casing

[module: SuppressMessage(
 "Microsoft.Naming",
 "CA1709:IdentifiersShouldBeCasedCorrectly",
 Scope = "type",
 Target = "EsriDE.Data.Access.IDbFactory",
 MessageId = "<WrongCasedWord>")]

[module: SuppressMessage(
 "Microsoft.Naming",
 "CA1709:IdentifiersShouldBeCasedCorrectly",
 Scope = "type",
 MessageId = "<WrongCasedWord>)]

Parametername should match base declaration

[SuppressMessage(
 "Microsoft.Naming",
 "CA1725:ParameterNamesShouldMatchBaseDeclaration",
 Justification = "Rule CA1725 has a bug when inspecting parameters from methods from interfaces. So suppress it with class.")]

Throwing ApplicationException

[SuppressMessage(
 "Microsoft.Usage",
 "CA2201:DoNotRaiseReservedExceptionTypes",
 Justification = "ApplicationException is OK.")]

FxCop is too strict

[SuppressMessage("
 Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "We decide that this is OK.")]

[module: SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Scope = "resource",
 Target = "EsriDE.PipelineManagement.Core.Properties.Messages.resources",
 MessageId = "Toolbar",
 Justification = "We decide that this is OK.")]

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "This is by design.")]

Code from untaught colleagues

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "Currently, we do not have enough knowledge or experience to fix this.")]

[SuppressMessage(
 "Microsoft.XYZ",
 "CAxyz:XYZ",
 Justification = "Cowboy-coding colleagues.")]

Specify a project-specific custom dictionary for FxCop build tasks and Visual Studio Team System static code analysis

Fri, 02 Jul 2010 11:27:00 +0200

Using a project-specific custom dictionary for FxCop and FxCop build tasks is very simple. The FxCopCmd call in the FxCop-target offers the parameter /dictionary:<DictionaryName> for that.

But for Visual Studio a little bit more steps are needed. And these steps must me gone for all projects.

Specify a custom dictionary for FxCop and Visual Studio source analysis

Tue, 11 May 2010 17:46:00 +0200

Renaming the default custom dictionary from CustomDictionary.xml to an other name – for instance FxCop.CustomDictionary.xml needs some additional changes to work in involved applications.

Visual Studio Team System code analysis

For Visual Studio Team System code analysis this file should be added as a link to all projects and set to be the Build Action CodeAnalysisDirectory.

Visual Studio 2005/2008 Code Analysis Error

Thu, 26 Nov 2009 12:52:00 +0100

After installing VS2005 TE on my machine (which previously runs Visual Studio 2008 TE) all mixed projects (VS2005/VS2008 compatibility with TargetFramework=2.0 and ToolsVersion=2.0 options) thrown an error during compilation:

C:\Program Files\MSBuild\Microsoft\VisualStudio\v8.0\CodeAnalysis\Microsoft.CodeAnalysis.targets(46,4):
error : In order to perform Code Analysis on managed binaries, MSBuild needs to launch FxCop.
MSBuild is unable to locate the FxCop binaries.
Make sure Visual Studio Team Edition for Software Developers or Visual Studio Team Suite is installed
and run MSBuild from within the "Visual Studio Command Prompt"
or specify the path to FxCop by setting the FXCOPDIR environment variable.

Specifying the FXCOPDIR-variable brings up the next obscure errors.

Using a custom dictionary in code analysis

Wed, 11 Nov 2009 09:22:00 +0100

Working with Microsoft FxCop

Wed, 11 Nov 2009 09:06:00 +0100

Run FxCop as a post build event

Since FxCop 1.36 it is possible to include FxCop in a post-build event.

So FxCop runs after compiling in Visual Studio and allows you directly jumping to the warned line.