This project is read-only.

StyleCop Help Documentation

Aug 9, 2010 at 3:55 PM

My developers are seeing many warning using StyleCop and we are very happy to have them now looking over their code with a fine tooth comb. However whenever they click on the warning and say show help...there isn't any help.

Where can my developers find sample code/help for each warning for how the code is supposed to be written?

Aug 9, 2010 at 6:59 PM
Edited Aug 9, 2010 at 7:02 PM

You could try downloading "StyleCop Rules Guide" from the "Downloads" tab.
It contains detailed description for each rules with code samples. 

Best regards,
Oleg Shuruev 

Aug 10, 2010 at 2:32 PM

The 'right-click, Show Error Help' menu option is excellent, but for it to be able to work you have to have StyleCop.chm in the Docs folder in the StyleCop directory.

Check the directory that StyleCop is running from.  If the help document isn't there then perhaps run the latest installer?

If everything is there, then you might have to right-click on the help document and unblock it or something.

I've never had an issue with it, so you're probably just missing the help file entirely.

Hope that helps!