Skip to main content

Code, code and code

In this post I will talk about 5 bad things that I saw in different projects. A part of them is common sense, but people forget about this.
Base class name convention
XXXBase class is defined and used as a base class. Until this point this is perfect, but what do you think about this:
public class XXXBase { … }
Why you defined a base class that you want to be used as a base class for other class without the abstract keyword. If you want a base class doesn’t forget to add the ‘abstract’ keyword. You can use the naming conventions but this will not stop people to create instances of your base clas..
Method named like the class
If you have a class named XXX, don’t define a method in your class named StartXXX, ConvertXXX. When a user uses an instance of XXX he will already know that he do the actions over XXX.
Examples:
Converter.StartConvert() – Converter.Start()
Service.StartService() – Service.Start()
Engine.StartEngine – Engine.Start() 
TODO comments and production
What do you think about this?
//TODO: Remove this hack in production
//TODO: Add logs in production
People tend to forget to check the TODOs before making a release. If you need a release of this kind, maybe you should create a task also. I saw application after one year in production with these kinds of comments. Before making a release, closing a sprint look over the TODOs.
URLs and string
When you are defining a component doesn’t use string to send urls. .NET has the Uri class for this. You will need to define a validation mechanism to check if the string represent a URL and is well defined. For a client is more clear when you have a parameter of type Uri and not a parameter of type string named serverAddress or serverUrl or serverUri …
Bizarre comment
if (xxx != null)
                {
                    // so bizarre...but if you don't, you'll ruin comms between the service and client
                    …
                    // so bizarre...but if you don't, you'll ruin comms between the service and client
                    …
                }
Why do you add this kind of comment? Do you think that people will understand the problem? In cases like this, you should describe the problem not add a comment that will make people never to change of fix the problem. Writing code is not VOOODOO Magic.
Have fun!

Comments

Popular posts from this blog

How to check in AngularJS if a service was register or not

There are cases when you need to check in a service or a controller was register in AngularJS.
For example a valid use case is when you have the same implementation running on multiple application. In this case, you may want to intercept the HTTP provider and add a custom step there. This step don’t needs to run on all the application, only in the one where the service exist and register.
A solution for this case would be to have a flag in the configuration that specify this. In the core you would have an IF that would check the value of this flag.
Another solution is to check if a specific service was register in AngularJS or not. If the service was register that you would execute your own logic.
To check if a service was register or not in AngularJS container you need to call the ‘has’ method of ‘inhector’. It will return TRUE if the service was register.
if ($injector.has('httpInterceptorService')) { $httpProvider.interceptors.push('httpInterceptorService&#…

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine:
threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration:

TeamCity.NET 4.51EF 6.0.2VS2013
It seems that there …

Run native .NET application in Docker (.NET Framework 4.6.2)

Scope
The main scope of this post is to see how we can run a legacy application written in .NET Framework in Docker.

Context
First of all, let’s define what is a legacy application in our context. By a legacy application we understand an application that runs .NET Framework 3.5 or higher in a production environment where we don’t have any more the people or documentation that would help us to understand what is happening behind the scene.
In this scenarios, you might want to migrate the current solution from a standard environment to Docker. There are many advantages for such a migration, like:

Continuous DeploymentTestingIsolationSecurity at container levelVersioning ControlEnvironment Standardization
Until now, we didn’t had the possibility to run a .NET application in Docker. With .NET Core, there was support for .NET Core in Docker, but migration from a full .NET framework to .NET Core can be costly and even impossible. Not only because of lack of features, but also because once you…