Configuration: Consider adding automated coding style checks #101

jcookems opened this Issue Jul 10, 2012 · 1 comment

2 participants


It is useful to have an automated coding-style checker to verify that the coding style within a project is consistent, especially a project being maintained by multiple people.

One tool that can be used is Style Cop (

StyleCop analyzes C# source code to enforce a set of style and consistency rules. It can be run from inside of Visual Studio or integrated into an MSBuild project. StyleCop has also been integrated into many third-party development tools.

Any rules deemed to be overly strict can be disabled by adding a configuration file in the project.

For example, here are some suggestions from Style Cop:

  • Warning SA1101: The call to IsMissingSettingException must begin with the 'this.' prefix to indicate that the item is a member of the class: AzureApplicationSettings.cs:172
  • Warning SA1405: A call to Debug.Assert must provide a message in the second parameter describing the reason for the assert: AzureApplicationSettings.cs: 114

Thanks for your suggestion Jason. We will investigate adopting this.

@piyushjo piyushjo closed this Mar 28, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment