How to exclude private members from StyleCop rule SA1600

customization static-analysis stylecop
Steven Evers picture Steven Evers · May 26, 2009 · Viewed 11.2k times · Source

Does anyone know how to change the StyleCop rule SA1600 that says elements must be documented so that it only applies to properties and not to private members?

Our ORM (DevExpress XPO) requires that you have private members for all public properties (because you have to call a function in the setter to persist it as well as storing it in the private member), and commenting both the public property and the private member with the same thing is killing me considering that some of the tables have upwards of 50 fields.

Answer

Jason Allor picture Jason Allor · May 27, 2009

Right click on your project node in Visual Studio, select StyleCop Settings. On the Rules tab, select the Documentation Rules node. In the right-hand pane, select the Ignore privates checkbox, and\or unselect the Include fields box. Either of these will achieve the desired effect.

Related questions

Android: Create a toggle button with image and no text

is it possible to create a toggle button in Android that has an image but no text? Ideally it would look like this: Ive seen similar posts where the answer was to change the background but i want to preserve …

Read More
Android toggle button custom look

I've been trying to customize the toggle button look but with no success. Here is how I want it to look like: Can someone give me a tutorial?

Read More
How to make my custom type to work with "range-based for loops"?

Like many people these days I have been trying the different features that C++11 brings. One of my favorites is the "range-based for loops". I understand that: for(Type& v : a) { ... } Is equivalent to: for(auto iv = begin(a); …

Read More