Documentation (CodePlex Wiki)

Jul 22, 2010 at 11:29 AM
Edited Jul 22, 2010 at 11:35 AM

I have some minor suggestions improving the documentation:

1. How to Use > Advanced Naming Rules > More Custom Rules > Read more about More Custom Rules <in documentation>. When I click the "in documentation" link I only get an empty page at http://stylecopplus.codeplex.com/wikipage?title=More%20Custom%20Rules&referringTitle=Home

2. Since I am new to StyleCop+ I'd like to know where I can find the UI described at http://stylecopplus.codeplex.com/#keyFeatures because I like to configure some advanced naming rules (e.g. I prefer _fieldName rather than m_fieldName)

3. http://stylecopplus.codeplex.com/wikipage?title=Compatibility%20Issues&referringTitle=Documentation I think this is a typo: "StyleCop is released with strong-signed core assemblies"? "strong-named core assemblies" (e.g. http://msdn.microsoft.com/en-us/library/wd40t7ad.aspx) You can "sign" an assemlby with a so called "strong-name"

4. using StyleCop and custom rules (e.g. NerdBank, StyleCop+, ...) with MSBuild You have to add the following line (depends on your configuration and used StyleCop version) to your project file(s) when you like that compiler warnings are generated:

On 32-bit systems:

<Import Project="$(ProgramFiles)\MSBuild\Microsoft\StyleCop\v4.3\Microsoft.StyleCop.targets" />

On 64-bit systems:

<Import Project="$(MSStyleCopTargetsPath)\Microsoft.StyleCop.targets" />

Best Regards,
Harald-René Flasch (aka hfrmobile)

Coordinator
Aug 6, 2010 at 2:59 PM

Hi Harald-René,

First of all, thank you very much for providing detailed feedback!

1.
These pages have not been created yet.
I've created stubs for them, also added "will be added later" text on home page.

2.
Haven't you found the UI now?
Seems to be important issue, because this UI (customization possibility) is the main feature of StyleCop+.
It is located on the separate settings page:

Only simple settings (like boolean) can be placed at the right "Detailed settings" pane. I use it for specifying options for Extended Original Rules (SPxxxx).
But settings for Advanced Naming Rules have complex UI, that is why they are placed at the separate tab page.

I've written about it in bottom description but seems it was not enough. 

3.
You are absolutely right. Fixed.

4.
Seems not to be directly related to "using StyleCop+ with old versions of StyleCop" issue.
More likely relates to "how to use StyleCop and with Visual Studio 2005" or "how to use StyleCop with MSBuild".
I mean that it relates to StyleCop at all, not to the specific StyleCop+.

Anyway, I will think about it.

 

Thank you once again for your feedback!

 

Best regards,
Oleg Shuruev

Aug 9, 2010 at 5:29 PM
D'oh! I am a fool or I need stronger glasses ;-) I haven't seen it ... Thank you for the screen-shot, now, even I see it ;-) Thank you!! May changing the text to "can be found in the StyleCop+ tab" for blind people like me ;-)
Coordinator
Aug 10, 2010 at 4:22 PM

Don't blame yourself so much :)
English is not my native (as you can guess), so some phrases may be not so short and understandable as they should.

For the next release I've updated text descriptions:

- StyleCop+ node (root node):
Plug-in that extends original StyleCop features. See StyleCop+ tab for detailed settings.

- Advanced Naming Rules node:
Provides wide and flexible variety of naming rules. See StyleCop+ tab for detailed settings.

 

Best regards,
Oleg Shuruev

Aug 10, 2010 at 7:12 PM
Perfect! Kind regards, Harald-René Flasch
Aug 11, 2010 at 5:21 PM
Edited Aug 11, 2010 at 5:37 PM
Where are the settings stored? Would be useful if developers can import/export the settings (advanced naming rules) in order to have the same settings on several development machines. EDIT: Fount it, also stored in Settings.stylecop ;-)