Skip to main content

Code Review: Class Comments

Let's talk in this post about code comments, around the following example.
    /// <summary>
    /// ... summary comments ...
    /// Note: If you change environment make sure you clear this file,as it will contain cached configuration
    /// </summary>
    public class ConfigurationPersister
    {        
        public T GetConfiguration<T>() { ... }        
        public void PersistConfiguration<T>(T configuration) { ... }
        internal bool HasConfiguration<T>() { ... }        
        private string CreateConfigFileName(string fileName) { ... }        
        private void CheckConfigDirectory() { ... }        
    }

Tags
First thing that we might notify is the 'NOTE' part. For this kind of scenarios we should use custom tags like '<remarks>'. In this way the other developer that is using the ConfigurationPersister (class), can see more clearly any remarks.
    /// <summary>
    /// ... summary comments ...
    /// <summary>
    /// <remarks>If you change environment make sure you clear this file,as it will contain cached configuration
    /// </remarks>
    public class ConfigurationPersister
    {        
        public T GetConfiguration<T>() { ... }        
        public void PersistConfiguration<T>(T configuration) { ... }
        internal bool HasConfiguration<T>() { ... }        
        private string CreateConfigFileName(string fileName) { ... }        
        private void CheckConfigDirectory() { ... }        
    }

In the summary, you should add only the content that is relevant. We should try to use other types of tags like '<remarks>' or '<see>', based on what kind of content we want to add there.

Location
The second thing that we notify is related what kind of information is specified in '<remarks>' tag. The comment specify that we should clean the content of the file if we change the environment. For the person that will use the application how does this information will be relevant?
Once you compile the code the comments are not relevant anymore for end user. The end user cannot see any kind of code comments.

Taking this into consideration, this comment should be added in a location where the end user can access it. In this case, this comment should be added inside the file where configuration is stored.
If the configuration file is generated dynamically,  we should push the comment from our code to the config. file.
<!--If you change environment make sure you clear this file,as it will contain cached configuration-->
<configuration>
  <ip>158.541.245.124</ip>
  <port>443</port>
</configuration>

Message

The last thing related to the message that is transmitted by the comment. A end user might not understand what does clear file means. It might be deleting the file, remove all content, remove a specific content from file.For end user it might not be clear what does change environment means.
It is recommended to provide clear information and try to define as clear as possible all actions. If you have at application level a glossary that defines clearly what each term or action means, that we are okay.

Conclusion
Before adding a comment try to:

  • See what is the real value of the comment
  • Why you need to add it 
  • Does the person that will read the comment will understand it
  • It is the right location (a message for end-user should never be added as code comment)

Comments

  1. If the configuration file is generated dynamically, we should push the comment from our code to the config. file.https://www.avaza.com

    ReplyDelete

Post a Comment

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…