A new code review item: Initializers in Alphabetical Order

By -

I’ve been using MZTools Visual Studio add-in for a few years. The original reason I acquired it was because of it’s sorting of code ability:

  • Sorting a collection of lines
  • Sorting the elements in a class by type and then alphabetical.

I had gotten frustrated by manual re-organizing  of code and fighting the random dropping of code where it fell into the file. I love the use of initializers – it keeps code cleaner and easier to read (visually chunking), but with rapid evolution of code, we can often end up with something like:

   1: deposit.CreditCard.AccountHolder = new AccountHolderDetail()
   2: {
   3:     AddressLine1 = GetString(CreditCardAddressLine1),
   4:     AddressLine2 = GetString(CreditCardAddressLine2),
   5:     Company = GetString(CreditCardCompany),
   6:     FirstName = GetString(CreditCardFirstName),                   
   7:     LastName = GetString(CreditCardLastName),                        
   8:     PostalCode = GetString(CreditCardPostalCode),
   9:     AddressLine3 = GetString(CreditCardAddressLine3),
  10:     City = GetString(CreditCardCity),
  11:     NumericCountryIsoCode = UnneededCallForIso(GetGuid(CreditCardCountryId)),
  12:     MiddleName = GetString(CreditCardMiddleName),
  13:     StateProvince = GetString(CreditCardStateProvinceId)
  14: };

If you are cross-checking two chunks of code, the random sequence becomes a pain and thus decreases code quality.  With two clicks the code is transformed into alphabetical order and the code is a lot easier to review or cross-checking.

 

So properly reviewed code would be:

   1: deposit.CreditCard.AccountHolder = new AccountHolderDetail()
   2: {
   3:     AddressLine1 = GetString(CreditCardAddressLine1),
   4:     AddressLine2 = GetString(CreditCardAddressLine2),
   5:     AddressLine3 = GetString(CreditCardAddressLine3),
   6:     City = GetString(CreditCardCity),
   7:     Company = GetString(CreditCardCompany),
   8:     FirstName = GetString(CreditCardFirstName),                   
   9:     LastName = GetString(CreditCardLastName),                    
  10:     MiddleName = GetString(CreditCardMiddleName),
  11:     NumericCountryIsoCode = UnneededCallForIso(GetGuid(CreditCardCountryId)),
  12:     PostalCode = GetString(CreditCardPostalCode),
  13:     StateProvince = GetString(CreditCardStateProvinceId)
  14: };

I would advocate that this be made a part of your regular code review standards, that is:

  • Initializers must be used when appropriate (most of the add-in tools will suggest/prompt you to do so and automatically refactor for you).
  • Initializers are in alphabetical order

Comments

Post a Comment

Popular posts from this blog

Yet once more into the breech (of altered programming logic)

By -
Once upon a time, long long ago, I wrote 8-bit programs in Tiny-C with absolute addressing being the only reality.  Then we had Borland Turbo-C with relative addresses and the joys of relative assembly jumps. Enter Windows and the joys of locking and unlocking memory blocks that you must allocated and manage yourself. Then came Visual Basic which evolved into .Net CLR and decreasing awareness of what is happening under the hood.   With VS2010 including F# and enhanced parallelism in .Net4, we actually have to go retro a bit – back to the world of having to understand the hardware. CPU speeds are no longer increasing – I have an old laptop from six+ years ago that ran at 3.2 GHz. This year I updated one of my machines off-the-shelf from Costco.com, an I7-920 with 4 cores and hyper-threading (8 CPUs appears in Task Manager) and 12 GB of DDR3 RAM. This week I ordered from Costco a Phenom II X6 (Yes – 6 REAL CORES) for one of my daughters.  This CPU will (according to YouTube demos) o
Read more

Simple WP7 Mango App for Background Tasks, Toast, and Tiles: Code Explanation

By -
Image
This is a continuation of this post , explaining how the sample app works. Caution : This sample isn’t meant as an example of best patterns and practices. If you see something in the code you would never do, then don’t. Solution File Organization The app has three Visual Studio Projects: the app, the agent, and the shared code library between them. One of the great things about Mango is that now the built-in Visual Studio Unit test functionality is available. By separating out the meat of the work into the SampleShared project, I can also focus my unit testing there. SampleApp1 The app has a MainPage, a ViewModel, and the WMAppManifest.xml file modified to note my ExtendedTask of BackgroundServiceAgent. The Agent is extremely simple with a call to the shared library, an update to the Tile, and a call to pop up Toast. The meat of the work is in the SampleShared library. The AgentMgr manages the background agent : add, remove, find, run now. It is only called f
Read more

How to convert SVG data to a Png Image file Using InkScape

By -
Image
Introduction The project required the need to put the visual pie chart on a web page on the client and in a Pdf file created on the server. I eventually choose to use a Telerik Kendo DataViz Chart control on the client, and use a PNG file on the server for the Pdf file. This blog post will explain the process and code to convert the client-side pie chart Svg data to a Png file, and provide a download to the working code. Prerequisites You need to have a trial version of the Telerik Kendo library installed in order to make the sample code work. You also need InkScape installed. InkScape is the application that does the actual conversion. You will need to change the Web.config appSetting of “ExeDirectoryForInkscape” to represent your own installation location. Any SVG Data Will Work The pie chart was created using the Telerik Kendo DataViz chart control. While I name a specific control, as long as you have access to the SVG data, the same conversion process on the server will
Read more