What's the best way to layout a C# class? [duplicate]
I tend to use Microsoft StyleCop, which has a set order according to rule SA1201:
Cause An element within a C# code file is out of order in relation to the other elements in the code.
Rule Description A violation of this rule occurs when the code elements within a file do not follow a standard ordering scheme.
To comply with this rule, elements at the file root level or within a namespace must be positioned in the following order:
- Extern Alias Directives
- Using Directives
- Namespaces
- Delegates
- Enums
- Interfaces
- Structs
- Classes
Within a class, struct, or interface, elements must be positioned in the following order:
- Fields
- Constructors
- Finalizers (Destructors)
- Delegates
- Events
- Enums
- Interfaces
- Properties
- Indexers
- Methods
- Structs
- Classes
Complying with a standard ordering scheme based on element type can increase the readability and maintainability of the file and encourage code reuse.
When implementing an interface, it is sometimes desirable to group all members of the interface next to one another. This will sometimes require violating this rule, if the interface contains elements of different types. This problem can be solved through the use of partial classes.
Add the partial attribute to the class, if the class is not already partial.
Add a second partial class with the same name. It is possible to place this in the same file, just below the original class, or within a second file.
Move the interface inheritance and all members of the interface implementation to the second part of the class.
I think there's no best way. There are two important things to consider when it comes to layout. The first most important thing is consistency. Pick an approach and make sure that the entire team agrees and applies the layout. Secondly, if your class gets big enough that you are searching for where those pesky properties live (or have to implement regions to make them easier to find), then your class is probably too large. Consider sniffing it, and refactoring based on what you smell.
To answer the reshaper question, check under Type Members Layout in Options (under the C# node). It's not simple, but it is possible to change the layout order.
I don't believe regions are necessarily a sign of bad code. But to determine that you will have to review what you have. As I've stated here this is how I regionize my code.
Enumerations
Declarations
Constructors
Methods
Event Handlers
Properties
But the main thing is keeping it consistent and purposeful.