Simplify and Restructure Your Code
Making it Easier to Read and Less Costly to Maintain
Refactor!™ by Developer Express fuses a language-independent state-of-the-art code shaping engine with a revolutionary and highly-optimized user experience. Unlike other refactoring solutions that target the system architect, Refactor! is designed to help all developers craft and sculpt their code with the speed and efficiency needed to meet their line of business demands.
What is Refactoring? Refactoring describes the process of making many small changes to working code, improving the internal structure without altering the external behavior of that code.
As an analogy, consider the math statement 2*4*5*3*1, you can covert this to 1*2*3*4*5 without changing its meaning and from there into 5!. They all mean the same thing but are increasingly easier to read. Refactor! does the same thing but with working source code.
There was a time not too long ago when just for fun developers would actually engage in obfuscated code competitions to produce the most difficult to read code. Well unfortunately there is a lot of code out there that is not much more readable than that intentionally obfuscated code - which is where refactoring comes in. The goal of refactoring is to take working code that is harder to read than it needs to be, and tweak its structure to make it more readable and more easily maintained.
.NET languages have been designed to self-document and encourage the development of readable, maintainable code - but even these languages code can grow organically over time and become cluttered and overly complex. Refactor! has numerous industry-first features that can help you take this complex code and make it easier to read and less costly to maintain.
Why Refactor!™
Refactor! does something no other tool can claim to do: it brings the power of an entire suite of refactoring tools to bear with just one key ("One Key Refactoring") and it works directly on your code in your editor - so you'll never have to leave your code just to restructure it.
Figure 1. One Key Refactoring - press CTRL+~ at any point to see all available refactorings with a short description of each.
Refactor! is built upon a language neutral architecture that offers exactly the same functionality for Visual Basic .NET, C#, C++ and ASP.NET developers. Refactor! even includes extensibility features to allow developers to easily build language-independent refactorings that can be used internally or shared with a growing community of highly satisfied Refactor! Pro customers.
Before we describe to you just a few of the over 110 refactorings available within the product, let us assure you that everything you can do with Refactor! can be rolled back using the standard Visual Studio Undo/Redo mechanism. So you really have the freedom to explore with this tool - simply hit CTRL+Z (or whatever key Undo is bound to) if the refactoring is not what you expected.
Refactoring: Reorder Parameters
Change the order of parameters in a Method signature, while also updating all calls to this method. Great when you need to change the parameter declaration order so that the most important parameters appear first, which will improve the usability of the method.
"Reorder Parameters" is probably the best example of how Refactor! is different, because the entire process is extremely visual and happens right there in your code. Here is how you reorder your parameters. Simply move the text cursor into the declaration of a method with parameters and this refactoring will be available. You can see that it is available if you stay there for a moment, because the refactoring smart tag will show up with a list of all the refactorings available. But you don't need to wait for anything - just hit the "One Key Refactoring" key (CTRL+~) and now you can move all your parameters left and right simply using the left and right cursor keys.
Figure 2. Reordering parameters directly upon code in the Editor - no modal dialogs to slow you down.
Refactoring: Rename
This refactoring renames a local variable or a private field, property or method. This refactoring affects both the declaration and any references within the class.
Choosing meaningful identifier names is one of the simplest ways to improve the readability of your code - Refactor! makes this process trivial. You simply put the text cursor into the identifier, and hit the "One key refactoring" key (CTRL+~), and start changing your identifier. You will see all references to your identifier highlighted with a light green box. You can now cycle through each call using the TAB and SHIFT+TAB keys, and if you change any one - the others all reflect the change.
Refactoring: Extract Method
The most sophisticated of all class based refactorings is probably "Extract Method". This refactoring allows you to select a piece of code from inside a method and extract it outside into a method of its own - while leaving a call to that new method in the code the method came from.
You are probably already several steps ahead of us in how to activate this refactoring by now; You simply select some code, put the text cursor in the code, hit the "One Key Refactoring" key (CTRL+~), and now you have a new method containing your block of code, with a call where that code came from.
Consider this example code which calculates the volume of a cylinder. Suppose we decide to extract the code that calculates the area of a circle to a method of its own, for later reuse. To do this all we do is select the specific block of code and hit the "One key Refactoring" (CTRL+~), the code is cut from the source method, and we are prompted for a location for the target method.
Figure 6. You can place the extracted method precisely using the red Target Picker.
Once we have chosen the location for the new method, Refactor! calculates how many parameters need to be passed, creates some default names for the new method and any parameters, generates the code for the new method and calls it, and finally invokes the "Rename" refactoring in case we wish to override any of the default names chosen.
Figure 7. The fully extracted method - Refactor has determined parameters to pass and even come up with a meaningful name.
You know there is actually an even faster way to extract. Select the code - Cut the code - Paste it outside the Method but inside the class and Refactor! will extract the method for you automatically.
Notice that the method name and the call are both linked with green boxes - the "Extract Method" has automatically invoked the "Rename" refactoring for you. Also if there are any variables referenced outside as well as inside the block you selected, then Refactor! will automatically give your new method the appropriate parameters to pass in that data and if needed pass it back.
Over 110 Built-in Refactorings
When it comes to scope, breadth, and ease-of-use, no other product in the market even comes close to Refactor! It would be impossible to describe each of the 110+ refactorings in detail within this white paper and so we wont try – but to whet your appetite, here are a few others worth consideration.
-
|
|
Compress to ternary expression / Expand ternary expression
Converts an if/else conditional with assignments in each branch into a ternary expression, or expands a ternary expression into an if/else block. |
-
|
|
Widen scope
Moves a variable declaration up and out in scope. |
-
|
|
Flatten conditional
Unindents the If or Else statement for a conditional. This will apply one of the following refactorings: Replace Nested Conditional with Guard Clause, Remove Redundant Else, or Reverse Conditional followed by Remove Redundant Else. Flatten conditional is also smart enough to recognize "if (E) return true; else return false;" and convert that condition to simply "return E;". |
-
|
|
Simplify expression
Resolves a complex expression to its simplest form. |
-
|
|
Combine conditionals
Combines two or more neighboring conditionals with identical bodies into a single conditional statement where each conditional expression is logically OR'd. |
-
|
|
Create method contract
Creates a contract for the current method, verifying that parameters are valid. |
-
|
|
Inline result
Replaces final assignments to the temporary variable with a statement that immediately returns the value, removing the temporary variable if possible. |
-
|
|
Move type to file
Creates a new file with the same name as the type at the caret, adds the file to the project, and then moves the type to that file, along with any leading comments, attributes, and XML doc comments. This refactoring is available when the caret is on a type declaration and the file contains two or more types. |
-
|
|
Use String.Format
Converts a composed string expression into a single String.Format call. |
-
|
|
Use StringBuilder
Replaces these string concatenation operations with method calls on a local StringBuilder instance to improve performance (working with a StringBuilder is faster than concatenating strings). |
-
|
|
Optimize namespace references
Removes unused namespace references (using/imports statements in VB and C#, and unused #include files in C++). |
Summary
Refactor! offers Visual Studio .NET developers a suite of integrated tools to help simplify code and make it infinitely easier to maintain - Tools that are surfaced on your code in the editor, for immediate access rather than the traditional solution of modal dialogs that simply slow you down and take you away from your code. Refactor! is the only tool that makes refactorings readily accessible without unwanted speed-bumps, reducing the risk and cost associated with improving the structure and maintainability of your code.
