StyleCop

COMMENTED ISSUE: SA1636 firing inappropriately

dnorthut — Fri, 06 Nov 2009 18:04:06 GMT

We are using Resharper 4.5 and StyleCop 4.3.

We have a project with many .CS files in it. All files were processed using Clean Code from Resharper. All files were modified to include an appropriate header as defined by StyleCop settings. Four of the many files consistently get an SA1636 on them. We cannot figure out why, and what the difference is between a file that receives no warning, and a file that does.
Comments: This appears to be caused by inclusion of the '©' symbol. If I replace it with '(c)' everything is fine.

CREATED ISSUE: SA1636 firing inappropriately

dnorthut — Fri, 06 Nov 2009 17:45:39 GMT

NEW POST: Visual Studio 2010 & .NET 4.0

MarcoErni — Fri, 06 Nov 2009 12:17:45 GMT

Hi

I have installed and integrated StyleCop into Visual Studio 2010, respectively into the C# projects as described in the following thread: http://code.msdn.microsoft.com/sourceanalysis/Thread/View.aspx?ThreadId=2283
It works just fine for Projects targeting .NET Framework 3.5 (or 3.0 & 2.0). But if the Project targets the .NET Framework 4.0, StyleCop fires allways the following two warnings:

- SA1003: The spacing around the symbol '=' is invalid.
- SA1633: The file has no header, the header Xml is invalid, or the header is not located at the top of the file.

Both warnings are issued by the the file "..\Local Settings\Temp\.NETFramework,Version=v4.0.AssemblyAttributes.cs"
It seems that Visual Studio 2010 produces that file an intermediate link this file into the C# project while building the project inside Visual Stduio.

Has anbody the same problem or better a solution for that issue?

Best Regards,
Marco Erni

COMMENTED ISSUE: VS 2005 IDE consumes 99% CPU when opening large unmanaged solution after installing StyleCop 4.3

phildevaney — Fri, 06 Nov 2009 08:59:35 GMT

NEW POST: VB Version?

sedge55 — Thu, 05 Nov 2009 23:04:06 GMT

I agree. Where's the VB version? Apart from the similarity with Java I completely fail to see the fascination with C#. VB code is so much easier to read. I'd also put in an ad for a documentation tool like NDoc for VB comments.

NEW POST: Installing StyleCop in w Team enviroment

Task — Thu, 05 Nov 2009 14:10:11 GMT

Uh, what?

I'm afraid I don't understand your question.

If you're hand-editing a .csproj file, something has gone terribly wrong.

NEW POST: SuppressMessage not working for certain rules??

olivier34 — Thu, 05 Nov 2009 13:00:38 GMT

Hi!

I do think that as StyleCop SuppressMessage must be set on an element, some rules, that applies to the whole file, can't be excluded this way.

Regards,

Olivier.

COMMENTED ISSUE: VS 2005 IDE consumes 99% CPU when opening large unmanaged solution after installing StyleCop 4.3

parky37 — Thu, 05 Nov 2009 07:24:16 GMT

After installing StyleCop 4.3, Visual Studio 2005 will consume 99% CPU (according to the Task Manager) when opening a large (~41 projects) solution containing mostly unmanaged C/C++ code. The CPU usage will occasionally drop to as low as 80%, but even after waiting several minutes while doing nothing, it did not drop down to an acceptable level.
This behaviour does not occur when opening a solution that consists of one C# project.
The CPU usage is so high it is almost impossible to select text in a source file, select menu items etc.
Uninstalling StyleCop resolves the issue with no other changes required.
Visual Studio is running in a standard user account (i.e. not an administrator account).
This issue is quite reproducible - I have installed and uninstalled StyleCop 4.3 several times to test this.
Comments: If this problem is still being looked into, here is a call stack on the main thread of devenv.exe. Hopefully, this will make more sense to you than it does to me: Microsoft.StyleCop.VSPackage.dll!Microsoft.StyleCop.VisualStudio.ProjectUtilities.GetProjectItemPath(EnvDTE.ProjectItem item = {System.__ComObject}) + 0x63 bytes Microsoft.StyleCop.VSPackage.dll!Microsoft.StyleCop.VisualStudio.ProjectUtilities.EnumerateProjectItem(EnvDTE.ProjectItem item = {System.__ComObject}, string name = "nameofaprojectinalargesolution", Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectInvoker projectCallback = {Method = Cannot evaluate expression because a native frame is on top of the call stack.}, Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectItemInvoker projectItemCallback = {Method = Cannot evaluate expression because a native frame is on top of the call stack.}, object projectContext, object fileContext) + 0x100 bytes Microsoft.StyleCop.VSPackage.dll!Microsoft.StyleCop.VisualStudio.ProjectUtilities.EnumerateProjectItems(EnvDTE.ProjectItems items, string name = "nameofaprojectinalargesolution", Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectInvoker projectCallback = {Method = Cannot evaluate expression because a native frame is on top of the call stack.}, Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectItemInvoker projectItemCallback = {Method = Cannot evaluate expression because a native frame is on top of the call stack.}, object projectContext = {Microsoft.StyleCop.VisualStudio.AnalysisHelper}, object fileContext = null) + 0x63 bytes Microsoft.StyleCop.VSPackage.dll!Microsoft.StyleCop.VisualStudio.ProjectUtilities.EnumerateProjectItem(EnvDTE.ProjectItem item, string name, Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectInvoker projectCallback, Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectItemInvoker projectItemCallback, object projectContext, object fileContext) + 0xcf bytes Microsoft.StyleCop.VSPackage.dll!Microsoft.StyleCop.VisualStudio.ProjectUtilities.EnumerateProjectItems(EnvDTE.ProjectItems items, string name = "nameofaprojectinalargesolution", Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectInvoker projectCallback = {Method = Cannot evaluate expression because a native frame is on top of the call stack.}, Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectItemInvoker projectItemCallback = {Method = Cannot evaluate expression because a native frame is on top of the call stack.}, object projectContext = {Microsoft.StyleCop.VisualStudio.AnalysisHelper}, object fileContext = null) + 0x63 bytes Microsoft.StyleCop.VSPackage.dll!Microsoft.StyleCop.VisualStudio.ProjectUtilities.EnumerateProject(EnvDTE.Project project, Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectInvoker projectCallback, Microsoft.StyleCop.VisualStudio.ProjectUtilities.ProjectItemInvoker projectItemCallback, object projectContext, object fileContext) + 0x149 bytes Microsoft.StyleCop.VSPackage.dll!Microsoft.StyleCop.VisualStudio.ProjectUtilities.SupportsStyleCop(Microsoft.StyleCop.VisualStudio.AnalysisHelper helper = {Microsoft.StyleCop.VisualStudio.AnalysisHelper}, Microsoft.StyleCop.VisualStudio.AnalysisType type) + 0x10f bytes Microsoft.StyleCop.VSPackage.dll!Microsoft.StyleCop.VisualStudio.PackageCommandSet.StatusAnalyzeSolution(object sender = {Microsoft.VisualStudio.Shell.OleMenuCommand}, System.EventArgs eventArgs) + 0x15 bytes Microsoft.VisualStudio.Shell.dll!Microsoft.VisualStudio.Shell.OleMenuCommand.OleStatus.get() + 0x29 bytes Microsoft.VisualStudio.Shell.dll!Microsoft.VisualStudio.Shell.OleMenuCommandService.Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget.QueryStatus(ref System.Guid guidGroup = {System.Guid}, uint nCmdId, Microsoft.VisualStudio.OLE.Interop.OLECMD[] oleCmd = {Microsoft.VisualStudio.OLE.Interop.OLECMD[1]}, System.IntPtr oleText = 45349544) + 0x166 bytes Microsoft.VisualStudio.Shell.dll!Microsoft.VisualStudio.Shell.Package.Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget.QueryStatus(ref System.Guid guidGroup, uint nCmdId, Microsoft.VisualStudio.OLE.Interop.OLECMD[] oleCmd, System.IntPtr oleText) + 0x47 bytes I'd really like to be able to use StyleCop again. Unfortunately, my company's main product is a large game composed of C++ projects so having nicely formatted source code files for the little tools I write isn't worth the suffering.

NEW POST: Installing StyleCop in w Team enviroment

Tokyoant — Wed, 04 Nov 2009 22:55:03 GMT

Thanks very much Task.

Do you need to add any import statements or the like into project files?

Thank you!

NEW POST: SuppressMessage not working for certain rules??

Task — Wed, 04 Nov 2009 20:14:28 GMT

jestersoftware wrote:
... any ideas? Am I placing the attribute wrong?

Could be.

He-he, show us yer code!

COMMENTED ISSUE: Syntax error warning calling methods on integer literals

bhazzard — Wed, 04 Nov 2009 19:58:09 GMT

Hi,

StyleCop is giving me the error: "SA0102: A syntax error has been discovered in file..." for lines of code where i use an extension method on an integer literal or a string literal such as:

100.Times( i => doSomething(i));
// or
"hello".Length
Comments: I also have this issue for extension methods on integer literals: 10.PercentOf(20); // which would return 2

NEW POST: Turn off SA0102

bhazzard — Wed, 04 Nov 2009 19:44:22 GMT

Is there anyway to turn off SA0102? I can turn off most of the other rules, but not this one.

Why should a style checking tool also check my syntax? My build will fail anyway if my syntax is truly wrong.

I have extension methods on int for example: 10.PercentOf(20) returns 2. StyleCop doesn't like this and raises a warning for SA0102 because it thinks it is incorrect syntax, but it builds and runs correctly, so...

NEW POST: Cannot Suppress SA1002 and SA1009

jestersoftware — Wed, 04 Nov 2009 16:29:33 GMT

I have the same question as FishDawg... why isn't suppression working? I'm having the same issue with SA1513 and SA1118:

1.

SuppressMessage("Microsoft.StyleCop.CSharp.ReadabilityRules", "SA1118:ParametersMustNotSpanMultipleLines", Justification = "The current code is more readable than StyleCop's suggestion.")

on method declaration: still getting warnings/errors.

2.

SuppressMessage("Microsoft.StyleCop.CSharp.LayoutRules", "SA1513:ClosingCurlyBracketMustBeFollowedByBlankLine", Justification = "See http://code.msdn.microsoft.com/sourceanalysis/WorkItem/View.aspx?WorkItemId=210.")

on method declaration: still getting warnings/errors.

Please help!

NEW POST: SuppressMessage not working for certain rules??

jestersoftware — Wed, 04 Nov 2009 15:41:57 GMT

And what if I don't want to turn off the rule in general, I want to do it for just one method, or just one statement within a method? Putting it at the method declaration doesn't seem to work, even though I read it's supposed to "use the suppression for all code within the scope, i.e. method"... any ideas? Am I placing the attribute wrong? I can get SA1600 to work just fine.

Thanks,
- Jesse

NEW POST: Installing StyleCop with MSBuild

Task — Wed, 04 Nov 2009 14:30:12 GMT

Tokyoant,

That's what the 3rd party StyleCop check-in policy is really good for:
http://teamfoundation.blogspot.com/2009/07/updated-stylecop-checkin-policy-v121.html

You can do it via MSBuild if you want, but utilizing the power of TFS would be my suggestion.

Enjoy!

NEW POST: Installing StyleCop in w Team enviroment

Task — Wed, 04 Nov 2009 14:24:15 GMT

Assuming that by "Team environment" you mean you're using TFS, then yes, I know a specific way to pull that off.

The method that I've found that works really well is:
- Add a StyleCop.Settings file to the solution (or even the Team Project if all developers work at that level) as a "Solution Item", check in the changes.
- Add a TFS check-in policy (free download!) to run StyleCop.

There are other ways, but that settings file in a top level directory that everyone will "Get Latest" on is really the key.

NEW POST: Installing StyleCop with MSBuild

olivier34 — Wed, 04 Nov 2009 09:08:10 GMT

Hi Tokyoant,

I suggest you just to follow the StyleCop setup wizard that will install files for MSBuild on Windows platform...
Not installed on developers' workstations means no check by developers before a Build.

Olivier.

NEW POST: Installing StyleCop in w Team enviroment

olivier34 — Wed, 04 Nov 2009 09:06:25 GMT

Hi Tokyoant,

You can manage StyleCop settings files with your Configuration Management Tool, like your source code files, so that they will be shared.

Olivier.

NEW POST: Why?

olivier34 — Wed, 04 Nov 2009 08:59:12 GMT

> a mechanism to regenerate the documentation
Yes, I agree that it could be a great feature.
+1
Olivier.

COMMENTED ISSUE: VS 2005 IDE consumes 99% CPU when opening large unmanaged solution after installing StyleCop 4.3

phildevaney — Wed, 04 Nov 2009 08:45:17 GMT