Code Quality Basics - Five Important Coding Standards


In this article, we talk about the five most important coding standards that I would recommend all developers to follow.

Article Series

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

Great Names

Giving great names to variables, methods and classes is, for me, the most important part of programming.

Try and give bad names to your variables, methods and classes, and you will discover that it becomes very difficult to understand what’s going on.

The name of a variable should represent what value it contains. The name of a method should represent what action it performs. The name of a class should be a noun that represents exactly what it is supposed to do.

If you are unable to give appropriate names to your variables/methods/classes, then it’s a code smell. Your are most probably doing too many things. Think about the Single Responsibility Principle and break it down.

Unfortunately, there is no automated way to check if the names of different elements are appropriate. The only way to do so, is peer code reviews.

Complexity

Complexity is generally measured by:

  • How many conditionals and loops are present in a single method in the code?

Cyclomatic complexity is a very good measure of how complex your method code is. The more complex the method is, the more difficult it is to understand.

Ideally, the cyclomatic complexity of a method should be less than 10.

Size Of Methods And Classes

It is highly desirable to have as small a method definition as possible, as it leads to a much better naming of the method. The length of a method should not exceed whatever you can see on a single screen.

The same is the case with classes. The smaller a class definition, the better the name you can give it. The size of a class should never exceed 200 lines.

Duplication

You need to have as little duplication in your code as possible. Typically, the standard measure we go by, is to keep it under 5 per cent of the total code.

Readability Of Code

When you look at a piece of code form an application, you should understand it very quickly.

Do check out our video on the same topic:

image info

Summary

In this article, we has a look at the five most important coding standards. Of these 5 coding standards, the first and the last, namely naming and readability standards, are the most difficult to achieve.

The other 3 standards can be enforced by using an automated tool such as SonarQube. SonarQube can measure code complexity, estimate the sizes of methods and classes, and check for code duplication as well. These checks can be run as part of continuous integration builds.

10 Step Reference Courses

Image Image Image Image Image

in28Minutes is helping 300,000 Learners across the world reach their learning goals. 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?