ReSharper Code Cleanup . . .

Cheese Pairing for this Post: Jarlsberg
[my favorite emmentaler; jarlsberg is excellent for snacking or sandwiches]

ReSharper will automatically clean and organize your code for you according to your specifications. The default specs are great; however, I find that I like to put my methods, field, etc in a slightly different order. Here is the config that I use. The only enhancement I still want to add is sorting auto properties before properties that have a backing member rather than intermixed. I haven't figured out how to accomplish that yet, so if anyone knows, please post the answer in the comments, thanks.

Without further ado:

<?xml version="1.0" encoding="utf-8" ?>
<Patterns xmlns="urn:shemas-jetbrains-com:member-reordering-patterns">
<!--Do not reorder COM interfaces-->
<Pattern><Match><And Weight="100"><Kind Is="interface"/><HasAttribute CLRName="System.Runtime.InteropServices.InterfaceTypeAttribute"/></And></Match></Pattern>
<!--Special formatting of NUnit test fixture-->
<Pattern RemoveAllRegions="true"><Match><And Weight="100"><Kind Is="class"/><HasAttribute CLRName="NUnit.Framework.TestFixtureAttribute" Inherit="true"/></And></Match>
<!--Setup/Teardow-->
<Entry><Match><And><Kind Is="method"/><Or><HasAttribute CLRName="NUnit.Framework.SetUpAttribute" Inherit="true"/><HasAttribute CLRName="NUnit.Framework.TearDownAttribute" Inherit="true"/><HasAttribute CLRName="NUnit.Framework.FixtureSetUpAttribute" Inherit="true"/><HasAttribute CLRName="NUnit.Framework.FixtureTearDownAttribute" Inherit="true"/></Or></And></Match></Entry>
<!--All other members-->
<Entry/>
<!--Test methods-->
<Entry><Match><And Weight="100"><Kind Is="method"/><HasAttribute CLRName="NUnit.Framework.TestAttribute" Inherit="false"/></And></Match><Sort><Name/></Sort></Entry></Pattern>
<!--Default pattern-->
<Pattern RemoveAllRegions="true">
<!--delegate-->
<Entry><Match><And Weight="100"><Access Is="public"/><Kind Is="delegate"/></And></Match><Sort><Access Order="public protected internal private" /><Name/></Sort></Entry>
<!--enums-->
<Entry><Match><Kind Is="enum"/></Match><Sort><Access Order="public protected internal private" /><Name/></Sort></Entry>
<!--constants-->
<Entry><Match><Kind Is="constant"/></Match><Sort><Access Order="public protected internal private" /><Name/></Sort></Entry>
<!--static and readonly fields-->
<Entry><Match><And><Kind Is="field"/><Or><Static/><Readonly/></Or></And></Match><Sort><Access Order="public protected internal private" /><Name/></Sort></Entry>
<!--fields-->
<Entry><Match><Kind Is="field"/></Match><Sort><Access Order="public protected internal private" /><Name/></Sort></Entry>
<!--Constructors. Place static one first-->
<Entry><Match><Kind Is="constructor"/></Match><Sort><Static/><Access Order="public protected internal private" /></Sort></Entry>
<!--Destructors. Place static one first-->
<Entry><Match><Kind Is="destructor"/></Match><Sort><Static/><Access Order="public protected internal private" /></Sort></Entry>
<!--Instance indexers-->
<Entry><Match><And><Kind Is="indexer"/><Not><Static/></Not></And></Match><Sort><Access Order="public protected internal private" /><Abstract/><Virtual/><Override/><Name/></Sort></Entry>
<!--instance properties-->
<Entry><Match><And><Kind Is="property"/><Not><Static/></Not><Not><Kind Is="indexer"/></Not></And></Match><Sort><Access Order="public protected internal private" /><Abstract/><Virtual/><Override/><Name/></Sort></Entry>
<!--Methods-->
<Entry><Match><And><Kind Is="method"/><Not><Static/></Not><Not><HandlesEvent /></Not><Not><Kind Is="destructor"/></Not></And></Match><Sort><Access Order="public protected internal private" /><Abstract/><Virtual/><Override/><Name/></Sort></Entry>
<!--Event Handling-->
<Entry><Match><HandlesEvent /></Match><Sort><Access Order="public protected internal private" /><Abstract/><Virtual/><Override/><Name/></Sort></Entry>
<!-- event -->
<Entry><Match><Kind Is="event"/></Match><Sort><Access Order="public protected internal private" /><Name/></Sort></Entry>
<!-- operator -->
<Entry><Match><Kind Is="operator"/></Match><Sort><Access Order="public protected internal private" /><Name/></Sort></Entry>
<!--Class indexers-->
<Entry><Match><And><Kind Is="indexer"/><Static/></And></Match><Sort><Access Order="public protected internal private" /><Abstract/><Virtual/><Override/><Name/></Sort></Entry>
<!--Class properties-->
<Entry><Match><And><Kind Is="property"/><Static/></And></Match><Sort><Access Order="public protected internal private" /><Abstract/><Virtual/><Override/><Name/></Sort></Entry>
<!--Class Methods-->
<Entry><Match><And><Kind Is="method"/><Static/></And></Match><Sort><Access Order="public protected internal private" /><Abstract/><Virtual/><Override/><Name/></Sort></Entry>
<!--all other members-->
<Entry><Sort><Access Order="public protected internal private" /><Abstract/><Virtual/><Override/><Name/></Sort></Entry>
<!--nested types-->
<Entry><Match><Kind Is="type"/></Match><Sort><Name/></Sort></Entry></Pattern>
</Patterns>

Comments

Post a Comment

Popular posts from this blog

TFS to SVN Conversion with History

Recently, the team I was on wanted to move our source code from Team Foundation Server to SVN for reasons that had almost nothing to do with source control directly. This would be a pretty simple operation, but we didn't want to lose access to the history when the operations team turned off the machine running TFS. We couldn't find any direct paths for moving history from TFS to SVN, so instead we chose to use git as an intermediary. Here's how we did it: Step 1 - Install the tools Install msysgit: http://code.google.com/p/msysgit/ Install git-tfs: https://github.com/git-tfs/git-tfs Step 2 - Pull TFS history to local git repository git tfs clone <tfs-project-url> "$/<tfs-project-name>/<tfs-project-folder>" <localfolder> example: git tfs clone http://tfs-001:8080/tfs/projectroot "$/Reference Architecture/ReferenceArchitecture" RefArch Step 3 - Initialize git-svn * User Lower Case - Caps will make it fail! * Change direc...
Read more

Simpler Tests: What kind of test are you writing?

One common problem that I see in test suites is confusion about what each test should cover. This confusion often leads to tests that are either too broad or too focused to accomplish the goal of the author. When writing a test, it is important to think about what kind of test it will be and the constraints that make that type of test effective. There are a few broad categories of tests that I keep in mind to help focus my testing: Unit Tests Also called micro tests, unit tests form the foundation of any good testing strategy. These are tests that test a single class or method in isolation from it's dependencies. Mocks and stubs help us isolate the code under test and make our tests more focused and expressive. A test that touches any external resource such as the database, the file system, a web service, etc is never a unit test. The primary purpose of unit tests is to validate that the subject under test is functionally correct for the expected inputs and outputs. Additiona...
Read more

Architecture at different levels of abstraction

Image
This week I am attending the O'Reilly Architecture Conference in NYC with my team and I had the pleasure of attending a two day training on Building Evolutionary Architectures presented by Neal Ford and Rebecca Parsons . During this session, on of the things we talked about extensively was coupling. We looked at dependency maps for different architectural styles including the big ball of mud . We saw something like the following and almost everyone agreed, "That is a bad architecture." Big Ball of Mud This reminded me of something I has seen elsewhere before, and after a quick search, I found it: Amazon and Netflix Death Star Architectures The ball of mud is considered obviously wrong by most architects, but the death star seems to be held up as an ideal by just as many and likely most of the same architects. Why is this? Are afferent coupling (inbound dependencies) and efferent coupling (outreaching dependencies) only important at a certain sc...
Read more