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

Why Database Modernization Matters for AI

  When companies transition to the cloud, they typically begin with applications and virtual machines, which is often the easier part of the process. The actual complexity arises later when databases are moved. To save time and effort, cloud adoption is more of a cloud migration in an IaaS manner, fulfilling current, but not future needs. Even organisations that are already in the cloud find that their databases, although “migrated,” are not genuinely modernised. This disparity becomes particularly evident when they begin to explore AI technologies. Understanding Modernisation Beyond Migration Database modernisation is distinct from merely relocating an outdated database to Azure. It's about making your data layer ready for future needs, like automation, real-time analytics, and AI capabilities. AI needs high throughput, which can be achieved using native DB cloud capabilities. When your database runs in a traditional setup (even hosted in the cloud), in that case, you will enc...

Cloud Myths: Migrating to the cloud is quick and easy (Pill 2 of 5 / Cloud Pills)

The idea that migration to the cloud is simple, straightforward and rapid is a wrong assumption. It’s a common misconception of business stakeholders that generates delays, budget overruns and technical dept. A migration requires laborious planning, technical expertise and a rigorous process.  Migrations, especially cloud migrations, are not one-size-fits-all journeys. One of the most critical steps is under evaluation, under budget and under consideration. The evaluation phase, where existing infrastructure, applications, database, network and the end-to-end estate are evaluated and mapped to a cloud strategy, is crucial to ensure the success of cloud migration. Additional factors such as security, compliance, and system dependencies increase the complexity of cloud migration.  A misconception regarding lift-and-shits is that they are fast and cheap. Moving applications to the cloud without changes does not provide the capability to optimise costs and performance, leading to ...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...