C# style: May properties be grouped with their backing fields?

Question

I like to organize simple properties like this:

private int foo;
public int Foo
{
    get { return foo; }
    set
    {
        // validate value
        foo = value;
    }
}

I've been playing around with StyleCop, and it yells at me for placing fields after constructors. Is this style generally accepted, as long as the field is never referenced outside of the property? Note: I realize that there is personal preference involved, but I am wondering if there is a general consensus regarding this issue.

score 6 · Accepted Answer · answered May 19 '11 at 20:44

6

Yes, that seems reasonable to me.

Typically I put all the fields and properties at the top, then the constructors, then the methods - but if you want to put them after the constructors, that seems reasonable too.

answered May 19 '11 at 20:44

Jon Skeet

1,421,763
867
9,128
9,194

score 4 · Answer 2 · answered May 19 '11 at 20:45

4

If your properties are going to be simple data access consider using auto properties:

public int Foo { get; set; }

The compiler will create a private member variable behind the scenes on your behalf.

Specifically to your question, don't put too much stock in tools like ReSharper or StyleCop. Some of the ways they format code, and the things they complain about are truly a matter of preference. I do not put the member variables near their public properties, but I can see how this would be convenient.

answered May 19 '11 at 20:45

Yuck

49,664
13
105
135

I can only guess that the downvote is because the OP has `// validate value` in their code sample, so they won't be just using simple properties that can be used that way. Don't really think that was worth a downvote, though. – Tim May 19 '11 at 20:55

score 2 · Answer 3 · answered May 19 '11 at 20:45

May? Since this only affects people on your team, you have to figure out what they think is best and go with that. Style Cop is often a bit... overboard on its recommendations.

I usually put them after the property, as the space above is reserved for documentation.

// placed up here, it looks kinda weird, imho
// private int foo;
/// <summary>
/// The index of the Foo in the <see cref="Bar"/>
/// </summary>
public int Foo
{
    get { return foo; }
    set
    {
        // validate value
        foo = value;
    }
}
private int foo;

score 1 · Answer 4 · answered May 19 '11 at 21:01

It may be a matter of preference, but this seems better than having them mixed with private members.

I usually use a nested region for backing fields inside the properties region since it doesn't interfere with visual studio comments and yet they are grouped toghether.

C# style: May properties be grouped with their backing fields?

4 Answers4