Why compiler warnings are your best friend
Jeroen Van Antwerpen - July 4, 2023
The software developer community is often perceived as a group of nitpickers, ready to criticize each other's work ruthlessly. As a software developer myself, I must admit that I sometimes feel frustrated when code reviewers point out trivial issues in my code. It seems like an example of toxic perfectionism to focus excessively on minor details, doesn't it?
Recognizing the importance of code readability
Blog post
So, what exactly qualifies as a nit? Software quality is as much about code readability and understandability as it is about delivering bug-free solutions. Code readability is essential to making the solution future-proof because, sooner or later, a colleague will have to modify your code to meet new or revised requirements. Numerous factors contribute to code readability.
Let’s explore a few common violations:
- declaring variables without using them;
- failing to use the return value of a declared function;
- using nonsensical or confusing variable names within a given context; and
- failing to use keywords from a new language version that make the code safer.
Blog post
Many code readability issues are technical in nature
Some issues — notably the one about using understandable variable names — are just a matter of using a commonly understood language correctly and being polite to anyone having to read your code.
But quite a lot of the readability issues are technical in nature. To identify and resolve these issues effectively, static program analysis can be extremely helpful. By activating the appropriate compiler warnings, developers can receive feedback and suggestions for improving their code quality. Compiler warnings can help you spot potential mistakes and guide you toward writing cleaner and more maintainable code.
Activating the right compiler warnings
Blog post
Unfortunately, the subject of compiler warnings is largely neglected in most education programs for professional software developers. However, at OMP, we recognize its importance and prioritize it accordingly. To give you an idea: the C++ compilers we use contain extended lists of possible warnings, and we regularly go through them to decide which ones to activate and which to deactivate. We also review these warnings whenever we upgrade a compiler.
We consider this an act of good housekeeping. While some of our newcomers find it a little disturbing to get so many warnings in the beginning, they soon find that it helps them to deliver better code and avoid unnecessary nitpicking by their colleagues. In the end, compiler warnings become an invaluable resource and a trusted ally.
Blog post
Jeroen Van Antwerpen
Software Architect at OMP BE
Biography
Joining OMP in 2012, Jeroen has delivered value in a number of areas of responsibility. His current focus as a C++ expert is delivering qualitative functionalities in the forecasting solution and supporting a range of developer projects.
