Code Quality Basics - What Is Readability Of Code?

Image Image

One activity that you be doing a lot as a programmer, is reading code. That’s where the concept of readability comes into the picture. How do you ensure that code written in a project is easily understandable?

You will learn

  • What is readability Of code?
  • What are the challenges with having bad code?
  • How do you improve readability of code?

Free Courses - Learn in 10 Steps

Article Series

This is second article in a series of 6 articles on important code quality terminology:

Readability Of Code - Example

Have a look at the following code example:

Example Code-1

	public Lock isLockAvailableForFile(long clientID, String status, boolean firstScreen, User user, List list) {
		Date sysTime = new Date();
		Lock lock = new Lock();
		if(list.size() > 0 && list.get(0) != null) {
			Object[] o1 = (Object[]) list.get(0);
			String userId = (String) o1[0];
			Date lockTimestamp = (Date) o1[1];
			if(userId != null) {
				//The message shown to the user
				String lockMsg = Constants.LOCK_REASON.replaceAll("@@[email protected]@", userId);

				//if userId is present, then lockTimestamp will also be present
				//72000000 milliseconds equals to 2 hours
				if(sysTime.gettime() - locktimestamp.getTime() > 7200000) {
					//The new user should attain lock only in the first screen
					//If 2 hours expires when user is not present on 1st screen, then user Id...
						|| userId.equalsIgnoreCase(user.getUserId())) {
						//to set the file access to write mode
									 "Write access is permitted to the User for client {0}",
						return lock;

					/*   ...  BLAH BLAH BLAH !!!  ...   */

Try and spend some time to see, whether this code is readable.

Would you like to see such code as part of your application?

Would you enjoy maintaining an applicaton that has code such as this?

Example Code-2

	public Lock isLockAvailableForFile(boolean isFirstScreen, User user, List list) {
		if(isListEmpty(list)) {
			return lockWithWriteAccess();
		Object[] lockObject = (Object[]) list.get(0);
		String userId = (String) lockObject[0];
		Date lockTimestamp = (Date) lockObject[1];

		if(userId == null) {
			return lockWithWriteAccess();

		boolean userHasLockedEarlier = userId.equalsIgnoreCase(user.userId);
		boolean lockPeriodExceeded = new Date().getTime() -
									 lockTimeStamp.getTime > 2 * 60 * 60 * 1000;

			return lockWithWriteAccess();
		if(lockPeriodExceeded && isFirstScreen)
			return lockWithWriteAccess();

		return lockWithReadAccess(userId);

The second example is refactored from the first example.

You can immediately see, that the second code is much more readable than the first.

Improving Readability of Code

What is the difference between these two examples?

Readability Is About Proper Naming

Readability of code is all about giving proper names. In general, the readability of code can be improved by 75% by properly naming variables, methods and classes.

For example, have a look at the extracted methods lockWithWriteAccess() and lockWithReadAccess(). With proper names such as these, you can identify the functionality very easily. There is almost no need to peek into the implementation details of the method to understand what it does.

Single Responsibility Principle

The next important factor is to ensure that we do only a single thing inside a particular method. If a method or a class does one thing only, then it is quite easy to give it a readable name.

Ensure Great Unit Tests

If you have great unit tests in place, you have the freedom to refactor code. You would no longer be worried about breaking functionality.

Adhere To Test-Driven Development (TDD)

With TDD, you write the tests before you write the code. You start with an outside-in perspective on your code. You are concerned about the interface, and that helps in writing great code.

Do check out our video on the same topic:

image info


In this article, we discussed readability of code and why it is important. We saw an example of code that has poor readability, and what it looked like after refactoring.

Best Selling Udemy Courses

Image Image Image Image Image Image Image Image Image Image Image Image

Join 450,000 Learners and 30+ Amazing Courses

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

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



Related Posts

Understanding jwt token

Let us understand the json web tokens

Single sign-on workflow

Let us understand the single sign-on workflow

Oauth2.0 - Resource Owner Password Credentials grant workflow

Let us understand the Oauth2.0 Resource Owner Password Credentials grant workflow

Oauth2.0 - Implicit grant workflow

Let us understand the Oauth2.0 implicit grant workflow

Oauth2.0 - Client Credentials grant workflow

Let us understand the Oauth2.0 client credentials grant workflow

Oauth2.0 - Authorization grant workflow

Let us understand the Oauth2.0 authorization grant workflow

Writing Integration Tests for Rest Services with Spring Boot

Setting up a basic REST Service with Spring Boot is a cake walk. We will go one step further and add great integration tests!

Integrating Spring Boot and Spring JDBC with H2 and Starter JDBC

Learn using Spring Boot Starter JDBC to connect Spring Boot to H2 (in memory database) using Spring JDBC. You will create a simple project with Spring Boot. You will add code to the project to connect to a database using Spring JDBC. You will learn to implement the basic CRUD methods.

JUnit Tutorial for Beginners in 5 Steps

JUnit Tutorial for Beginners in 5 Steps. Setting up a basic JUnit example and understanding the basics of junit.

JPA and Hibernate Tutorial For Beginners - 10 Steps with Spring Boot and H2

JPA and Hibernate in 10 Steps with H2 - Setting up a basic project example with Spring Boot and in memory database H2. Its a cake walk.