Microsoft Cloud Authors: Nick Basinger, Kevin Benedict, Pat Romanski, Liz McMillan, Lori MacVittie

Related Topics: Microsoft Cloud

Microsoft Cloud: Article

Why Code Snippets Are Not My Cup of Tea

But how about a few good refactoring options in the Visual Studio menu

I can see another comparison between the files buried inside the HaveSameContent method. The function starts by comparing the file size. This code can be extracted to a separate method. You can make this method public, so the class can be used for file size comparison. An extracted method looks like this:

Public Function HaveSameLength() As Boolean
Return file1Info.Length = _
End Function

It’s time to remove all unnecessary comments from the HaveSameContent method. Also, since we have established that an actual, byte-by-byte comparison is only performed on files of the same size, you can simplify the condition in the While statement. It is enough to check that either byte1 or byte2 is greater than 0.

After these modifications, the HaveSameLength method looks like Listing 3. This code is actually a bit easier to read. This helps me realize one important fact, which has to do with one border condition. If the length of both files is zero, the method will return the result “False”. Now, we might argue about how we understand content equality, but I think that the majority would expect this function to return a result of “True” if both files are zero length. In my judgment, this constitutes a bug.

Had I written this code from zero, I would have probably written the appropriate unit tests. Then there would be a better chance for this border condition to be tested and for this bug to be discovered in time.

To fix this, you can introduce a guard clause. It means you will test for a special condition at the beginning of the method. If both files are zero length, exit the method right away while returning the result “True”.

While you’re at it, it makes sense to test for another special condition. Nothing prevents a client from sending the same string as the first and second file. This means that two files, file1 and file2, are actually the same physical file. For example:

If New Files(“C:/file1.txt”, “C:/file1.txt”).HaveSameContent() Then ...

In this case, if you try to execute the comparison with the original snippet code, you will end up with System.IO.IOException: {“The process cannot access the file ‘C:\file1.txt’ because it is being used by another process.”}, since the algorithm used is accessing both files simultaneously. Since the two paths in our example point to the same physical file, IOException is produced when an attempt is made to open the second file; the file is already taken. The solution is to treat this as another special case. Again, we can argue about what file equality means, but as in the previous case, I think that most of us would expect the HaveSameContent method to return the result “True” if both files are one and the same physical file and not to throw IOException.

Listing 4 provides the complete code of a Files class. Not only have you simplified and corrected the original method, you managed to structure it in a more object-oriented manner. By declaring file1Info and file2Info as fields in a Files class, you made them accessible to all class members and have managed to avoid passing them as parameters to all of the newly created methods. Only this fact, however, might not convince you that organizing the code in the form of a class was justified.

The HaveSameContent method will compare two files byte-by-byte. This is suitable for comparing binary files. However, some other file types, like text or XML files, might have different comparison semantics. In the case of XML files, the files can be considered equal even if they are not equal to the last byte. For example, two XML files might have different comments, white space, or node order, but will still produce the same output when parsed. If you need to implement XML file comparison functionality, some of the methods you already implemented in the Files class can come in handy. While a difference in length does not result in inequality between two XML files, other preconditions expressed in the methods OnlyOneZeroLength, AreBothZeroLength and PointToSamePhysicalFile apply here as well. The easiest way to implement an XML file comparison is to create a new XmlFiles class that will inherit a Files class and override the HaveSameContent method. Before that, however, the HaveSameContent method must be marked as “Overrideable” and the OnlyOneZeroLength, AreBothZeroLength and PointToSamePhysicalFile method visibility changed from Private to Protected. The code for both classes will look something like Listing 5.

I’m not suggesting you should implement XmlFiles before you even have a use for it. However, a correctly structured Files class will make implementing XML files or another file comparison class like XmlFiles, TextFiles, etc., a lot easier, once you do need it.

I think this wraps it up for the example. I hope that was enough to explain my position. To summarize, let me recap the effects that Code Snippets can have on your code and development process that make me not so enthusiastic about this Visual Studio feature:

  • Code Snippets can lead to duplicated code inside your source code.
  • Code Snippets can promote a copy-paste style of reuse.
  • Code contained in code snippets can not be unit-tested inside the Code Snippet tool.
  • As we have seen earlier in this article, code that comes with code snippets is sometimes not on the same quality level as, for example, .NET API code.

I would trade the Code Snippets feature for a few good refactoring options in the Visual Studio menu without a second thought.

More Stories By Danijel Arsenovski

Danijel Arsenovski is a software developer from Santiago, Chile. He works as a Product and Solutions Architect at Excelsys S.A, designing Internet banking solutions for numerous clients in the region. He started experimenting with refactoring while overhauling a huge banking system, and he hasn't lost interest in refactoring ever since. He pioneered the use of refactoring as a vehicle for a VB 6 code upgrade to VB .NET. Danijel is the author of "Professional Refactoring in Visual Basic" published by Wrox, and is a contributing author for several major publications. He holds a Microsoft Certified Solution Developer (MCSD) certification and was named Visual Basic MVP in 2005. He blogs at http://blog.vbrefactoring.com.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.

IoT & Smart Cities Stories
Nicolas Fierro is CEO of MIMIR Blockchain Solutions. He is a programmer, technologist, and operations dev who has worked with Ethereum and blockchain since 2014. His knowledge in blockchain dates to when he performed dev ops services to the Ethereum Foundation as one the privileged few developers to work with the original core team in Switzerland.
René Bostic is the Technical VP of the IBM Cloud Unit in North America. Enjoying her career with IBM during the modern millennial technological era, she is an expert in cloud computing, DevOps and emerging cloud technologies such as Blockchain. Her strengths and core competencies include a proven record of accomplishments in consensus building at all levels to assess, plan, and implement enterprise and cloud computing solutions. René is a member of the Society of Women Engineers (SWE) and a m...
Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereal. Andrew's role at ConsenSys Enterprise is a mul...
Whenever a new technology hits the high points of hype, everyone starts talking about it like it will solve all their business problems. Blockchain is one of those technologies. According to Gartner's latest report on the hype cycle of emerging technologies, blockchain has just passed the peak of their hype cycle curve. If you read the news articles about it, one would think it has taken over the technology world. No disruptive technology is without its challenges and potential impediments t...
If a machine can invent, does this mean the end of the patent system as we know it? The patent system, both in the US and Europe, allows companies to protect their inventions and helps foster innovation. However, Artificial Intelligence (AI) could be set to disrupt the patent system as we know it. This talk will examine how AI may change the patent landscape in the years to come. Furthermore, ways in which companies can best protect their AI related inventions will be examined from both a US and...
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...
Bill Schmarzo, Tech Chair of "Big Data | Analytics" of upcoming CloudEXPO | DXWorldEXPO New York (November 12-13, 2018, New York City) today announced the outline and schedule of the track. "The track has been designed in experience/degree order," said Schmarzo. "So, that folks who attend the entire track can leave the conference with some of the skills necessary to get their work done when they get back to their offices. It actually ties back to some work that I'm doing at the University of San...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...
Bill Schmarzo, author of "Big Data: Understanding How Data Powers Big Business" and "Big Data MBA: Driving Business Strategies with Data Science," is responsible for setting the strategy and defining the Big Data service offerings and capabilities for EMC Global Services Big Data Practice. As the CTO for the Big Data Practice, he is responsible for working with organizations to help them identify where and how to start their big data journeys. He's written several white papers, is an avid blogge...
Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...