Comments on: Microsoft Source Analysis

By: trasa

trasa — Fri, 30 May 2008 20:46:10 +0000

@chris: I’m mostly trolling at this point, name your private fields whatever you want

[troll]with R# it’s also trivial to rename ‘em later muhuhahaha[/troll]

OK i’ll stop now promise

By: Chris Brandsma

Chris Brandsma — Fri, 30 May 2008 20:06:40 +0000

@trasa:

I agree with you about the ‘m’, I got rid of those a while back as well (at the request of my manager…who shall not be named…and who also blogs on elegant code.

The problem with your variable name is that it breaks another rule, you can’t have underscores INSIDE variable names.

And auto properties help…as long as your properties don’t need to do anything interesting (default values, raise event when changed, etc).

By: trasa

trasa — Fri, 30 May 2008 19:02:15 +0000

@chris, I just use R# to identify that sort of scoping issue for me

why stop at _? m_module_level_variable_type_string_firstName (i’m kidding..)

I suppose with autogenerated properties, 90% of your _variables go away now anyhow.

By: Chris Brandsma

Chris Brandsma — Fri, 30 May 2008 17:10:36 +0000

@trasa, I like knowing where my variables are declared, plus it keeps me from having to worry about variable scoping. Otherwise I’d end up declaring my local variables like this: string localName;

Sorry, I had a prior horror of working on a delphi project with a slightly incompetent developer. Delphi allowed global values. So in his globals section he declared:
CHB: char;

Then in his procedures, he declared:
CHB: int;

All over the blasted place. The global version of CHB was a ‘C’, ‘H’, or a ‘B’, the local version was a 1,2, or 3. I could have killed him (if he didn’t live in another state). Sorry, after dealing with that, I will scope my variables.

As for curly braces, I’m having that discussion every hour right now with a guy I’m working with.

By: trasa

trasa — Fri, 30 May 2008 17:00:26 +0000

Boo, underscores! They are the last remnant of the discredited Hungarian notation.

Now, lets argue about where to put the curly braces!

By: Paul Jackson

Paul Jackson — Fri, 30 May 2008 12:40:24 +0000

I had the same issue with underscores in field names. Though I’m in the opposite camp, personally, I can’t convince co-workers to get rid of them … can I trade a few of mine for your cranky, old Dutchman?

The first thing I did was investigate writing a custom rule to do this: http://lovethedot.blogspot.com/2008/05/creating-custom-rules-for-microsoft_6976.html

I’ll probably find some “gotchas” as time goes on, but for now it’s working well on our code.

By: Reflective Perspective - Chris Alcock » The Morning Brew #101

Reflective Perspective - Chris Alcock » The Morning Brew #101 — Tue, 27 May 2008 07:13:34 +0000

[...] Microsoft Source Analysis – Chris Brandsma looks at some of the rules in the Microsoft Source Analysis tool, and consider the possibility of conflicts in rules between similar tools. [...]

By: Chris Brandsma

Chris Brandsma — Mon, 26 May 2008 14:39:44 +0000

@Tobias: OK, here is what I have found so far on writing add-ins.

First: there are three important files:
Microsoft.SourceAnalysis.dll
Microsoft.SourceAnalysis.CSharp.dll <- parses C# document
Microsoft.SourceAnalysis.CSharp.Rules.dll

If you look at SpacingRules, here is your inheritance tree:

SpacingRules, Microsoft.SourceAnalysis.CSharp.Rules
SourceAnalyzer, Microsoft.SourceAnalysis
SourceAnalysisAddIn, Microsoft.SourceAnalysis

SourceAnalyzer has several virtual functions that you will have to implement: AnalyzeDocument and DelayAnalysis. Via both of them you get a CodeDocument object. CodeDocument is actually another abstract class, the real class is CsDocument.

Interesting, it looks like everything is implemented in such a way that adding VB support is actually possible (just not currently done).

By: Dew Drop - May 26, 2008 | Alvin Ashcraft's Morning Dew

Dew Drop - May 26, 2008 | Alvin Ashcraft's Morning Dew — Mon, 26 May 2008 13:58:10 +0000

[...] Microsoft Source Analysis (Chris Brandsma) [...]

By: Tobias Hertkorn

Tobias Hertkorn — Mon, 26 May 2008 07:13:41 +0000

If you want a first hint at how to write your own rules – I was curious as well about that and put together a small post:
http://saftsack.fs.uni-bayreuth.de/~dun3/archives/writing-your-own-rules-for-microsoft-source-analysis-for-c/153.html

I know it is not much – but it might get you started in the right direction.

On regards to Source Analysis: I found it quite funny that the default Console Application shipping with VS would not even pass the tests.

Cheers,
Tobi