Skip to main content

Coding Stories - string.Format and enum as const

Looking over some code this days I found the fallowing things.

1. Odd way of using string.Format
The fallowing code is extracted from an application:
Trace.WriteLine(string.Format("{0}{1}{2}{3}{4}{5}{6}", 
    "Generating ", 
    count, 
    " strings of size ",
    stringSize, 
    " took ", 
    duration, 
    " milliseconds."));
Trace.WriteLine(string.Format("{0}{1}{2}", 
    "Only ", 
    strings.Count, 
    " strings were generated due to uniqueness constraint."));
As we can see, ‘string.Format’ is overused. The code is not only hard to read and maintain, but the arguments are used everywhere, even when part of the string are constant. Even the spaces around words are fully missing from the format.
The above code should look something like this:
Trace.WriteLine(string.Format("Generation {0} strings of size {1} tool {2} milliseconds.", 
     count, 
     stringSize, 
     duration));
Trace.WriteLine(string.Format("Only {0} strings were generated due to uniqueness constraint.", 
     strings.Count));

2. Using ‘enum’ to manage int const
I was surprise to find this interesting way to declare const.
    public enum Constants
    {
        RandomStringSize = 2,
        Count = 500,
        KeyMaxValue = 1000,
        NumberOfReadings = 100000
    }
...
    public class FooSet
    {
        private const int count = (int)Constants.Count;
        private const int keyMaxValue = (int)Constants.KeyMaxValue;
        private const int numberOfReadings = (int)Constants.NumberOfReadings;
...
    }
    public class Car
    {
        private const int count = (int)Constants.Count;
        private const int keyMaxValue = (int)Constants.KeyMaxValue;
        private const int numberOfReadings = (int)Constants.NumberOfReadings;
...
    }
First of all why we would need to declare constants as an enum. Usually we are using enum when we have different states of possible values for a specific case. For example Color.Red, Color.Blue, Color.Black.
If we need to reuse const. in multiple location we could create a 'configuration' class that could contain this const (this class could be static). But keeping them as an enum.... hmmm.
There is a smell in the moment when we need to convert enum to int. What would happen if the const would be char or string? I don't want to imagine how you could convert it.
In this case, because the const are used in multiple classes (4 classes), without a direct connection between them, I would create a static class with this 4 const and use it directly where is needed. In this moment there is no need for mocking this value or changing them at runtime.  
    public static class RandomStringConstants
    {
        public const int RandomStringSize = 2;
        public const int Count = 500;
        public const int KeyMaxValue = 1000;
        public const int NumberOfReadings = 100000;
    }

Comments

Popular posts from this blog

Windows Docker Containers can make WIN32 API calls, use COM and ASP.NET WebForms

After the last post , I received two interesting questions related to Docker and Windows. People were interested if we do Win32 API calls from a Docker container and if there is support for COM. WIN32 Support To test calls to WIN32 API, let’s try to populate SYSTEM_INFO class. [StructLayout(LayoutKind.Sequential)] public struct SYSTEM_INFO { public uint dwOemId; public uint dwPageSize; public uint lpMinimumApplicationAddress; public uint lpMaximumApplicationAddress; public uint dwActiveProcessorMask; public uint dwNumberOfProcessors; public uint dwProcessorType; public uint dwAllocationGranularity; public uint dwProcessorLevel; public uint dwProcessorRevision; } ... [DllImport("kernel32")] static extern void GetSystemInfo(ref SYSTEM_INFO pSI); ... SYSTEM_INFO pSI = new SYSTEM_INFO(

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.51 EF 6.0.2 VS2013 It see

Navigating Cloud Strategy after Azure Central US Region Outage

 Looking back, July 19, 2024, was challenging for customers using Microsoft Azure or Windows machines. Two major outages affected customers using CrowdStrike Falcon or Microsoft Azure computation resources in the Central US. These two outages affected many people and put many businesses on pause for a few hours or even days. The overlap of these two issues was a nightmare for travellers. In addition to blue screens in the airport terminals, they could not get additional information from the airport website, airline personnel, or the support line because they were affected by the outage in the Central US region or the CrowdStrike outage.   But what happened in reality? A faulty CrowdStrike update affected Windows computers globally, from airports and healthcare to small businesses, affecting over 8.5m computers. Even if the Falson Sensor software defect was identified and a fix deployed shortly after, the recovery took longer. In parallel with CrowdStrike, Microsoft provided a too