Introduction To Code Quality


In this article, we discuss code quality and why you should have great code quality.

You will learn

  • What is Code Quality?
  • Why do you need to track Code Quality?
  • What are the approaches to evaluate Code Quality of an application?
  • What are the popular code quality tools?

Article Series

This is the first article in a series of eight articles on Code Quality

What Is Code Quality?

Code quality is a measure of how maintainable your code is.

The next question that comes up is - how do you measure code quality?

The way you do that is by having

  • Static Analysis
  • Peer code reviews

Setting the Right Coding Standards

Having the right coding standards is an important starting point to having great code. Most organizations have coding standards at the enterprise level as well. Coding standards ensure a certain level of code consistency, when a developer moves from one module to another within a project, or from one project to another within an organization.

You can read more about it here

Static Analysis

Static analysis of code can be done by using tools such as SonarQube. A best practice that is recommended is to perform static analysis of your code at least once a day.

Also ensure that you have processes in place to keep reviewing them.

Make sure that your code quality standards are set as part of you Definition Of Done. At the end of every sprint, evaluate your code against the set code quality standards, and see if it matches up to them.

Static Analysis with SonarQube

One of the best ways to measure code quality is by using a tool such as SonarQube:

image info

SonarQube looks at your code form a wide variety of perspectives. It look at angles such as the types of:

  • Bugs
  • Security vulnerabilities
  • Code smells - patterns in code that could indicate hidden bugs
  • Code Coverage - How good are your unit tests, and how much code do they cover
  • Amount of Code Duplication

All these are good measures of code quality.

You can read more about static analysis here - Code Quality Basics - Best Practices in Static Code Analysis with SonarQube

Peer Reviews

Static analysis is not a silver bullet. Use peer reviews to identify things that cannot be found in static analysis.

Code Review is one of the most important components in ensuring great Code Quality in your projects.

Remember that a code review is not a tool to find fault with others efforts.

Here are a couple of important goals:

  • A code review is done to add value to the system and the people in the team.
  • It also adds to a list of best practices that team members can follow.

You can read more about Code Review Best Practices

Do check out our video on the same topic:

image info

Summary

In this article, we had an overview of what code quality is all about. We saw that it can be ensured by using static analysis tools, and by doing peer code reviews. There are several parameters to evaluate the quality of an application’s code.

10 Step Reference Courses

Image Image Image Image Image

in28Minutes is creating amazing solutions for you to learn full stack and the cloud - Docker, Kubernetes, AWS, React, Angular etc. Click here for the complete catalogue of 30 Courses.

Related Posts

Spring Boot Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. This resources will help you learn and gain expertise at Spring Boot.

Spring and Spring Boot Video Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. Here's a list of video tutorials and courses for you

Software Design - Separation Of Concerns - with examples

Software architects and programmers love having Seperation of Concerns. What is it? Why is it important? Let's get started.

Object Oriented Software Design - Solid Principles - with examples

Software design is typically complex. Object oriented design takes it to the next level. There are a number of design patterns and other stuff to be aware of. Can we make things simple? What are the goals to aim for when you are doing object oriented design? SOLID Principles is a great starting point for Object Oriented Design.

Software Design - Open Closed Principle - with examples

Open Closed Principle is one of the SOLID Principles. You want your code to be easily extended. How do you achieve it with minimum fuss? Let's get started.

Software Design - What is Dependency Inversion Principle?

Dependency Inversion Principle is one of the important SOLID Principles. Dependency Inversion Principle is implemented by one of the most popular Java frameworks - Spring. What is it all about? How does it help you design good applications?

Introduction to Four Principles Of Simple Design

With agile and extreme programming, the focus is on keeping your design simple. How do you keep your design simple? How do you decide whether your code is good enough?

Software Design - Single Responsibility Principle - with examples

For me, Single Responsibility Principle is the most important design principle. What is Single Responsibility Principle? How do you use it? How does it help with making your software better? Let's get started.

REST API Best Practices - With Design Examples from Java and Spring Web Services

Designing Great REST API is important to have great microservices. How do you design your REST API? What are the best practices?

Designing REST API - What is Code First Approach?

Designing Great REST API is important to have great microservices. Code First approach focuses on generating the contract from code. Is it the best possible approach?