StyleCop

NEW POST: VB Version?

danieldsmith — Mon, 23 Nov 2009 19:06:00 GMT

Seems to me like the VB version would only need one rule:

if (language == "VB.NET")
{
DisplayWarning("Use a real language like C#");
}

I am (partially!) joking of course. I'm sure there will be support in a future version. That said however, VB usage in the industry is on a steady decline, so how much of a priority it should be getting is another question. For example in a recent Telerik poll asking which langauge devs are primarily developing in, VB usage trailed in at just 30% compared to C# on nearly 70%. Here's some facts to back this up:

http://telerikwatch.com/2009/06/survey-says-c-still-more-popular-than.html
http://www.google.com/trends?q=VB.NET%2C+C%23&ctab=0&geo=all&date=ytd&sort=0
http://radar.oreilly.com/2009/02/state-of-the-computer-book-mar-22.html

COMMENTED ISSUE: Visual Studio 2010 Beta 1 support

jasonall — Thu, 19 Nov 2009 18:23:09 GMT

Is possible to use StyleCop using VS2010 B1?

Thanks,
Matteo.
Comments: Work is currently underway on a version of StyleCop that will integrate into the Visual Studio 2010 shell.

NEW POST: Hide StyleCop Warnings when running msbuild

jasonall — Thu, 19 Nov 2009 18:19:18 GMT

Try setting StyleCopEnabled=false at the top of your .bat file.

NEW POST: VB Version?

LeeB — Thu, 19 Nov 2009 16:56:20 GMT

(Sigh.) Much as we'd all like to believe the mighty Microsoft has unlimited resources, it just isn't true. Hey, I'd like to see a StyleCop for every language available on .NET, but I don't think we'll be seeing that anytime soon. Really folks, we have four options, not necessarily mutually exclusive:

Be patient while the folks at MS break down the technical barrier
Write the tool ourselves, perhaps adapting something that already exists
Improve our coding habits--is it really that hard to follow the conventions used by MS's code examples?
Learn a different language--no single language is best at everything; .NET gives you plenty to pick from

Regarding the last point, the days of being a monolingual, single-platform developer are over. Expand your horizons, and bring back what you've learned to your preferred language and platform.

NEW POST: VS2010 Beta2?

TATWORTH — Thu, 19 Nov 2009 15:40:01 GMT

Any update on when VS2010 support will be added?

COMMENTED ISSUE: Visual Studio 2010 Beta 1 support

TATWORTH — Thu, 19 Nov 2009 15:34:38 GMT

Is possible to use StyleCop using VS2010 B1?

Thanks,
Matteo.
Comments: What about working with VS2010 Beta 2?

NEW POST: Hide StyleCop Warnings when running msbuild

eusebiu — Thu, 19 Nov 2009 08:57:34 GMT

Hello.

I have a .bat file that is compiling some targets projects using msbuild command and I use also style cop to verify my code rules.
I want to hide the warnings that stylecop produces. I tried /consoleloggerparameters:ErrorsOnly;Verbosity=q with no luck. The only thing that did it is specifying /noconsolelogger but this one hides everything.

Is this possible?

Thanks,
Eusebiu

NEW POST: Cannot Suppress SA1002 and SA1009

Tallek — Wed, 18 Nov 2009 17:21:28 GMT

I was having the same problem with SA1118 but managed to fix it. I opened up the rules assembly in reflector and looked at the rules enumeration. Turns out the rule name in the help file and the enumeration representing it don't always match 100%. In this case, the enumeration was ParameterMustNotSpanMultipleLines versus the rule name of ParametersMustNotSpanMultipleLines. Notice the extra "s" on "Parameter" in the rule name. When i left out the "s" and just used the enumeration name it worked. Looking a bit more, i can see the xml files for all the rules in the Resources folder in reflector (looking at Microsoft.StyleCop.CSharp.Rules.dll). In the ReadabilityRules xml file, i see the same issue with it using the name without the "s" on "Parameter".

NEW POST: SA1009 with type-casting parenthesis

shuruev — Tue, 17 Nov 2009 10:02:03 GMT

jasonall wrote:
The recommendation is to have no space after the cast. I'm not sure why you're getting the violatiohn on that line. Maybe if you include more of the code we can figure it out.

Jason,
Thanks for the answer.

Actually, I have two questions:
1. I am using reflection and getting SA1009 when using "typeof" and casting in one line. It seems to be a little bug. I don't get SA1009 when I don't use "typeof" or when I put space after cast and before "typeof".
2. What do you think about creating a rule that would prohibit putting a space after cast? I consider this as a "bad style", but it's up to you to decide, of course.

Here is the code example that illustrates them.

using System;
using System.Reflection;

namespace Shuruev.StyleCop.Test
{
/// <summary>
/// Some code that illustrates wrong SA1009 firing.
/// </summary>
public static class Class1
{
public static readonly Uri TestUri = new Uri("http://www.microsoft.com");

/// <summary>
/// I assume there is some problem with "typeof" checking
/// because the first part of code produces SA1009 (seems it should not).
/// The second part (with space after cast) doesn't produce SA1009,
/// but I I really don't like this way of typing.
/// </summary>
public static void Test1()
{
string innerA = (string)typeof(Uri).InvokeMember(
"m_String",
BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField,
null,
TestUri,
null);

string innerB = (string) typeof(Uri).InvokeMember(
"m_String",
BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField,
null,
TestUri,
null);
}

/// <summary>
/// Here both parts work fine and don't produce SA1009.
/// But I think it would be nice to create a new rule that would prohibit putting a space after cast.
/// </summary>
public static void Test2()
{
string innerA = (string)TestUri.GetType().InvokeMember(
"m_String",
BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField,
null,
TestUri,
null);

string innerB = (string) TestUri.GetType().InvokeMember(
"m_String",
BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField,
null,
TestUri,
null);
}

/// <summary>
/// Here both parts work fine and don't produce SA1009.
/// But I think it would be nice to create a new rule that would prohibit putting a space after cast.
/// </summary>
public static void Test3()
{
Type type = typeof(Uri);

string innerA = (string)type.InvokeMember(
"m_String",
BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField,
null,
TestUri,
null);

string innerB = (string) type.InvokeMember(
"m_String",
BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField,
null,
TestUri,
null);
}
}
}

Best regards,
Oleg Shuruev

NEW POST: Visual Web Developer

krappies — Tue, 17 Nov 2009 09:42:11 GMT

Thanks

NEW POST: SA1009 with type-casting parenthesis

jasonall — Tue, 17 Nov 2009 08:40:31 GMT

The recommendation is to have no space after the cast. I'm not sure why you're getting the violatiohn on that line. Maybe if you include more of the code we can figure it out.

Jason

NEW POST: Visual Web Developer

jasonall — Mon, 16 Nov 2009 18:21:16 GMT

VWD does not allow loading external VS packages, which prevents StyleCop from integrating into the shell. You can still use StyleCop by setting up MSBuild integration, as described in this blog post: http://blogs.msdn.com/sourceanalysis/pages/source-analysis-msbuild-integration.aspx

NEW POST: Visual Web Developer

krappies — Mon, 16 Nov 2009 16:24:43 GMT

Hi

Is there a way to use StyleCop with VWD 2008? I cannot find a way to do this.

Thanks,
Pieter

COMMENTED ISSUE: SA1636: Copyright character not matched in GlobalSuppressions.cs file.

rbratton — Thu, 12 Nov 2009 16:19:35 GMT

I have defined a copyright string in Settings.StyleCop using the copyright symbol "©". In every other C# file, the text is matched OK and I don't get a warning. In the GlobalSuppressions.cs file, StyleCop says the exact string is not found even though I cut and paste the text from files where there is no problem.

Then I looked at the Settings.StyleCop file itself. The copyright symbol is displayed as "Â©". When I put these 2 characters in place of the normal copyright symbol in the GlobalSuppressions.cs file, the warning does not appear. And it is only for the GlobalSuppressions.cs file that I have to use "Â©". All the other C# files pass with just the normal copyright symbol.
Comments: Yes, I saw that--maybe I should have added on to that one. Anyway, I thought I'd provide a little more information about the problem and the workaround I discovered. Thanks.

NEW POST: File Header Format

olivier34 — Thu, 12 Nov 2009 12:48:27 GMT

olivier34 wrote:
It seems also that special chars like the (c) from copyright do not work when set in the match expression...

A new issue has been posted: http://code.msdn.microsoft.com/sourceanalysis/WorkItem/View.aspx?WorkItemId=260

COMMENTED ISSUE: SA1636: Copyright character not matched in GlobalSuppressions.cs file.

olivier34 — Thu, 12 Nov 2009 12:47:36 GMT

I have defined a copyright string in Settings.StyleCop using the copyright symbol "©". In every other C# file, the text is matched OK and I don't get a warning. In the GlobalSuppressions.cs file, StyleCop says the exact string is not found even though I cut and paste the text from files where there is no problem.

Then I looked at the Settings.StyleCop file itself. The copyright symbol is displayed as "Â©". When I put these 2 characters in place of the normal copyright symbol in the GlobalSuppressions.cs file, the warning does not appear. And it is only for the GlobalSuppressions.cs file that I have to use "Â©". All the other C# files pass with just the normal copyright symbol.
Comments: Problem about the copyright char was asked before in this post (http://code.msdn.microsoft.com/sourceanalysis/Thread/View.aspx?ThreadId=394) but not responded...

CREATED ISSUE: SA1636: Copyright character not matched in GlobalSuppressions.cs file.

rbratton — Wed, 11 Nov 2009 23:52:01 GMT

NEW POST: how to disable some rules

lory — Wed, 11 Nov 2009 12:58:33 GMT

I like most of rules, but in real practice, I would like to disable some of them. But I cannot find how to disable some rules. Can anyone give some help?

NEW POST: Visual Studio 2010 & .NET 4.0

MarcoErni — Tue, 10 Nov 2009 10:06:24 GMT

I have solved problem. The issue is that the default C# MSBuild targets file generates and adds this file intermediatly to the project structure, so StyleCop will check this file. To avoid that StyleCop is checking this file simply import the StyleCop targets before the import of the C# default targets.

Importing projects like this:
<Import Project="$(ProgramFiles)\MSBuild\Microsoft\StyleCop\v4.3\Microsoft.StyleCop.targets"/>
<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets"/>

rather then explained on http://code.msdn.microsoft.com/sourceanalysis/Thread/View.aspx?ThreadId=2283
<Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets"/>
<Import Project="$(ProgramFiles)\MSBuild\Microsoft\StyleCop\v4.3\Microsoft.StyleCop.targets"/>

Hope this helps also others ...
Marco Erni

CREATED ISSUE: Rule suggestion: File contains unused usings

ncalinoiu — Mon, 09 Nov 2009 16:07:37 GMT

If implemented, the rule should allow exclusion of certain namespace (e.g.: System) via configuration.