Code Quality Basics - Five Important Coding Standards


Image Image


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

Free Courses - Learn in 10 Steps

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.

Related Posts

Docker Tutorial for Beginners - with Java and Spring Boot

Learn about Docker - What is Docker? Why Is Docker Popular? How to create Docker Image for a Java Spring Boot App?

Devops Tutorial | DevOps with Docker, Kubernetes and Azure DevOps

What is DevOps? How is it different from Agile? What are the popular DevOps Tools? What is the role of Docker, Kubernetes and Azure DevOps in DevOps. Let's get started with a simple usecase.

Deploy Java Spring Boot Applications to AWS, Azure, GCP with Docker and Kubernetes

In this article, we focus our attention on the cloud. How to learn the cloud and deploy Java Spring Boot Applications to AWS, Azure, GCP with Docker and Kubernetes?

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.

Microservices with Spring Boot and Java - Part 1 - Getting Started

Let's learn the basics of microservices and microservices architectures. We will also start looking at a basic implementation of a microservice with Spring Boot. We will create a couple of microservices and get them to talk to each other using Eureka Naming Server and Ribbon for Client Side Load Balancing. In part 1 of this series, lets get introduced to the concept of microservices and understand how to create great microservices with Spring Boot and Spring Cloud.

20+ Spring Boot Projects with Code Examples

At in28Minutes, we have created more than 20 projects with code examples on Github. We have 50+ articles explaining these projects. These code examples will you learn and gain expertise at Spring Boot.

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?

Index - 500+ Videos

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

Creating Spring Boot and React Java Full Stack Application with Maven

This guide helps you create a Java full stack application with all the CRUD (Create, Read, Update and Delete) features using React as Frontend framework and Spring Boot as the backend REST API. We use Maven as the build tool.

Creating a SOAP Web Service with Spring Boot Starter Web Services

Let's learn how to create a SOAP Web Service with Spring Boot Starter Web Services. We will take a Contract First approach by definining an XSD and exposing a WSDL from it.

FREE COURSES



in28Minutes Best Selling Udemy Courses

Image Image Image Image Image Image Image Image Image

450,000 Learners are pursuing our 31 amazing courses and 6 Learning Paths. Start Now!

Join 450,000 Learners and 30+ Amazing Courses

LEARN DEVOPS - 200+ VIDEOS - Master DevOps with Docker, Kubernetes and Azure DevOps


350,000 Learners are learning everyday with our Best Selling Courses : Spring Boot Microservices, Spring, Spring Boot, Web Services, Hibernate, Full Stack React, Full Stack Angular, Python, Spring Interview Guide, Java Interview, Java Functional Programming, AWS, Docker, Kubernetes, PCF, AWS Fargate and Azure


85,000 Subscribers are learning from our Free Videos on YouTube : JSP Servlets, Spring, Spring Boot, Spring MVC, Hibernate, Eclipse, Maven, JUnit, Mockito, Full Stack - React, Full Stack - Angular, Docker, Kubernetes, AWS, AWS Fargate, PCF and Azure


Here are the recommend articles to read next : Spring Interview Questions, Spring Boot Interview Questions, Microservices, Hibernate, Spring Security, REST API with Spring Boot, Full Stack with React, SOAP Web Services, Exception Handling, Embedded Servers, Spring Data Rest, Spring vs Spring MVC vs Spring Boot, Building Web Application and Spring Data JPA.

You can checkout all our 100+ articles here - All Articles.


Do not know where to start your learning journey? Check out our amazing learning paths:
Learning Path 01 - Spring and Spring Boot Web Applications and API Developer,
Learning Path 02 - Full Stack Developer with Spring Boot, React & Angular,
Learning Path 03 - Cloud Microservices Developer with Docker and Kubernetes,
Learning Path 04 - Learn Cloud with Spring Boot, AWS, Azure and PCF and
Learning Path 05 - Learn AWS with Microservices, Docker and Kubernetes


Subscribe