Code Quality on Marko Apfel

Running StyleCop without an installation to empower continuous integration

Mon, 07 Nov 2011 22:32:00 +0100

Problem

A continuous integration server should only have a minimal toolset installed. This ensures that no unwanted libraries could affect the build and other steps.

Clearly that with this slogan also StyleCop should not be installed to the CI server. But we wanna have this analysis as an part of the whole build.

About trials, spikes, samples, prototypes and clean code

Mon, 04 Jul 2011 14:38:00 +0200

Writing clean code is only possible if you are known with the uses technology. Often during a development process this level must initially be reached.

To distinguish the levels of understanding I guess separate folders under the DevTree:

Let ReSharper and Code Contracts work together

Sun, 05 Jun 2011 23:55:00 +0200

ReSharper by default does not recognize Contract.Requires as an annotation hint, that the proofed condition furthermore is true.

So it comes to the effect, that using the following contract definition causes ReSharper to squiggle the next access and output a wrong hint:

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.

Event Naming Guidelines

Wed, 14 Jul 2010 08:47:00 +0200

Rules

The following rules outline the naming guidelines for events:

Use Pascal case.
Do not use Hungarian notation.
Use an EventHandler suffix on event handler names.
Specify two parameters named sender and e. The sender parameter represents the object that raised the event. The sender parameter is always of type object, even if it is possible to use a more specific type. The state associated with the event is encapsulated in an instance of an event class named e. Use an appropriate and specific event class for the e parameter type.
Name an event argument class with the EventArgs suffix.
Consider naming events with a verb. For example, correctly named event names include Clicked, Painting, and DroppedDown.
Use a gerund (the “ing” form of a verb) to create an event name that expresses the concept of pre-event, and a past-tense verb to represent post-event. For example, a Close event that can be canceled should have a Closing event and a Closed event. Do not use the BeforeXxx/AfterXxx naming pattern.
Do not use a prefix or suffix on the event declaration on the type. For example, use Close instead of OnClose.
In general, you should provide a protected method called OnXxx on types with events that can be overridden in a derived class. This method should only have the event parameter e, because the sender is always the instance of the type.

from: .NET Framework General Reference - Event Naming Guidelines

Integrate NUnit in Hudson CI-server

Wed, 07 Jul 2010 15:41:00 +0200

Precondition

Naming

Its a good practice to have a common naming schema for test projects, fixture categories and fixture. Especially to configure automatic runs of unit tests is much more easier with this.

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.

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.

StyleCop throws documentation warning SA1600 for private elements

Thu, 12 Nov 2009 06:24:00 +0100

if you see the following warnings in your code:

You have two choices:

deactivate the rule but this disables this rule for all documentations – also the wanted
tune the detail settings In the settings editor you see additional options if you select the “Documentation Rules” root node

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.

Nachtrag: Casting Anti-Pattern

Thu, 29 Oct 2009 12:40:00 +0100

Wie so oft im Leben sind manche Dinge auf den zweiten Blick komplexer als sie auf dem Ersten den Anschein haben.

Es kam die Anfrage, ob es nicht doch einen Unterschied zwischen as und is gibt & dann wurden noch ein paar Inputs gefunden, dass im Falle des “Überladens von Cast-Operatoren” mögliche Fallen lauern.

Casting Anti-Pattern

Thu, 29 Oct 2009 12:35:00 +0100

Im unten stehendem Code ist ein Anti-Pattern, welches immer wieder im ArcObjects-Kontext zu beobachten ist.

if (element is IMapSurroundFrame)
{
 IMapSurround mapSurround = ((IMapSurroundFrame)element).MapSurround;
 ..

Es wird eine is-Abfrage gemacht (element is IMapSurroundFrame) und dann ein Stück später der tatsächliche Cast ((IMapSurroundFrame)element).