Skip to main content

New team member and code guidelines

Being a developer doesn’t mean that you are staying alone in a small room, in front of a computer and writing in a mystic programing language. Being a developer means working in a team, with real people, where you need to communicate and being part of a team. The code that is written by a developer will end to be modify by another developer from the same team or company. This means that is very important to write the code to respect the team and project standard.
But what should you do when one of guidelines are not part of your ‘believes’? For example adding a comment to each public class/interface or method.
There are developers that will NOT respect the guideline, will fight for it until the end of the world and will say NO – ‘I will never respect this guideline because is bullshit’.
This is an extremist approach and I think that this approach is not better than the one when you accept everything. In this cases the most important thing is communication. You need to understand why that guideline exist (it came from the team, architect, PM, company or client).
You should explain why the guideline is not good, but be aware, one time is not enough, because you may have people that use that guideline for 10-15 years and for them is a religion. Small steps are the best option in this cases.
But if none of the solutions works and all the team say that the guideline is good then you have two options:
Respect their decision, write code using their guideline (you didn’t lost the fight, but you need more mitigation – time is your best friend)
Leave the team and the project (the extremist developer : - ) )
The worst thing that you can do is to write code using your own guidelines. Even if you don’t like the guidelines, you should not ignore their guidelines. If you have 1 million lines of code written using a specific guideline, starting to write a part of the code with your own guidelines is a big mistake.
It is okay to write a small PoC where you can show them why that guideline is wrong, without making a push to the main repository.
In conclusion we could say that being a new member in a team can be hard, but you need to be a team player and accept other believes also.


  1. From my point of view, sometimes three lines of comment are not enough, but sometimes one line of comment is too much. There is no sense to set up a policy that requires comment for every public methods, because many methods can be trivial and described correctly by their name. On the other hand, if the method does something extraordinary, than more comments are required. If we set up a policy that every public method should be commented including the trivial ones, programmers will hate commenting, but the quality of the comments will be strange. I think, there is no sense to add a comment "Gets the users" to the method GetUsers, not to mention the trivial public properties. What is the intention of adding comment? Increasing the size of the code or adding extra data which can't be read out of the code?

    1. The comments rule was only an example for coding guideline.


Post a Comment

Popular posts from this blog

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 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 …

GET call of REST API that contains '/'-slash character in the value of a parameter

Let’s assume that we have the following scenario: I have a public HTTP endpoint and I need to post some content using GET command. One of the parameters contains special characters like “\” and “/”. If the endpoint is an ApiController than you may have problems if you encode the parameter using the http encoder.
using (var httpClient = new HttpClient()) { httpClient.BaseAddress = baseUrl; Task<HttpResponseMessage> response = httpClient.GetAsync(string.Format("api/foo/{0}", "qwert/qwerqwer"))); response.Wait(); response.Result.EnsureSuccessStatusCode(); } One possible solution would be to encode the query parameter using UrlTokenEncode method of HttpServerUtility class and GetBytes method ofUTF8. In this way you would get the array of bytes of the parameter and encode them as a url token.
The following code show to you how you could write the encode and decode methods.

Entity Framework (EF) TransactionScope vs Database.BeginTransaction

In today blog post we will talk a little about a new feature that is available on EF6+ related to Transactions.
Until now, when we had to use transaction we used ‘TransactionScope’. It works great and I would say that is something that is now in our blood.
using (var scope = new TransactionScope(TransactionScopeOption.Required)) { using (SqlConnection conn = new SqlConnection("...")) { conn.Open(); SqlCommand sqlCommand = new SqlCommand(); sqlCommand.Connection = conn; sqlCommand.CommandText = ... sqlCommand.ExecuteNonQuery(); ... } scope.Complete(); } Starting with EF6.0 we have a new way to work with transactions. The new approach is based on Database.BeginTransaction(), Database.Rollback(), Database.Commit(). Yes, no more TransactionScope.
In the followi…