Why you should care
Refactorability – Branches ending with break or end can be easily reordered without having their changing their functionality.
Consistency – Similar branches should have a consistent ending as it makes the code easier to read and understand.
Protection – Ending all switch branches with a break is a fantastic habit as it helps in detecting missing break statements which is crucial for debugging and troubleshooting
Ending switch branches with ‘breaks’ helps the code be more consistent, functional, and easier to debug. This allows developers in different teams navigate the code easier and be more productive in the development process. Lack of breaks makes the code difficult for other developers to understand.
CAST recommends developers to build habits on making switch cases more readable by adding ending breaks where needed. This habit can be fostered by following a standardized guide internally set by the company which follows specific guidelines on writing code. Not all switch cases need ending breaks so long as the code is understandable without compromising its’ functionality.
The key points to follow regarding switch cases is that the best programs are built from consistent code that focuses on functionality first. Since many companies are shifting towards an agile-based environment, it is easy for development teams to get lost in the shuffle, especially with developers with their unique programming habits. While having a style guide helps, it is also important to have developers undergo training and be constantly updated on new technologies that are to be implemented in future projects.
How we detect
int i = 2;
cout << “0” << endl;
// No violation: Empty clause
cout << “1 or 2” << endl;
break; // No violation: A break
cout << “Other” << endl;
// No violation: Last clause is default
It checks for a ‘switch’-clause that does not end with a ‘break’, ‘return’ or ‘throw’. This construct should be at the top level in the ‘switch’-clause. However, the rule is also triggered if the last ‘switch’-clause of a ‘switch’ statement is ‘default’, and does not explicitly end with ‘break’, ‘return’ or ‘throw’.
About CAST and Highlight’s Code Insights
Over the last 25 years, CAST has leveraged unique knowledge on software quality measurement by analyzing thousands of applications and billions of lines of code. Based on this experience and community standards on programming best practices, Highlight implements hundreds of code insights across 15+ technologies to calculate health factors of a software.