Improving code readability

Introduction

Readable code is easier to understand and fix. It helps you and others work better together.

When writing code that others will read or maintain.

When you want to find and fix bugs faster.

When you come back to your own code after some time.

When working in a team to keep code consistent.

When preparing code for learning or teaching.

Syntax

C

/* Use clear variable names */
int totalScore;

/* Add comments to explain tricky parts */
// Calculate average score
float average = (float)totalScore / count;

/* Use consistent indentation and spacing */
if (average > 50) {
    printf("Passed\n");
} else {
    printf("Failed\n");
}

Use meaningful names instead of short or unclear ones.

Comments should explain why, not what the code does.

Examples

Use age instead of a to make the purpose clear.

C

int a; // bad name
int age; // good name

A comment helps explain the formula used.

C

// Calculate area of circle
float area = 3.14 * radius * radius;

Proper spacing and indentation make code easier to read.

C

if(score>60){printf("Pass");}else{printf("Fail");}

// Better formatting:
if (score > 60) {
    printf("Pass\n");
} else {
    printf("Fail\n");
}

Sample Program

This program uses clear variable names, comments, and good formatting to make it easy to read.

C

#include <stdio.h>

int main() {
    int score = 75; // Student's score

    // Check if the student passed
    if (score >= 60) {
        printf("Passed\n");
    } else {
        printf("Failed\n");
    }

    return 0;
}

Important Notes

Keep lines short to avoid scrolling sideways.

Use blank lines to separate different parts of code.

Review your code by reading it out loud to check clarity.

Summary

Use clear names and comments to explain your code.

Keep formatting consistent with spaces and indentation.

Readable code saves time and helps teamwork.