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.

Practice

1. Why is it important to use meaningful variable names in C code?

easy

A. It makes the program run faster.

B. It makes the code easier to understand for others and yourself.

C. It reduces the size of the compiled program.

D. It allows the compiler to optimize memory usage.

Solution

1. Step 1: Understand variable naming purpose

   Meaningful names describe what the variable holds, making code clearer.

2. Step 2: Consider code readability impact

   Clear names help anyone reading the code understand its purpose quickly.

3. Final Answer:

   It makes the code easier to understand for others and yourself. -> Option B

4. Quick Check:

   Meaningful names improve readability [OK]

Hint: Choose names that describe purpose clearly [OK]

Common Mistakes:

• Using single letters without context
• Using vague names like temp or data
• Ignoring naming conventions

2. Which of the following is the correct way to format an if statement in C for better readability?

easy

A. if (x > 0) { printf("Positive"); }

B. if(x>0){printf("Positive");}

C. if(x > 0)printf("Positive");

D. if ( x>0 ) {printf("Positive");}

Solution

1. Step 1: Check spacing around operators and keywords

   if (x > 0) { printf("Positive"); } uses spaces after if, around operators, and braces properly.

2. Step 2: Check consistent brace placement

   if (x > 0) { printf("Positive"); } places braces with spaces, improving readability.

3. Final Answer:

   if (x > 0) { printf("Positive"); } -> Option A

4. Quick Check:

   Proper spacing and braces improve readability [OK]

Hint: Use spaces around operators and braces consistently [OK]

Common Mistakes:

• Skipping spaces after keywords
• Putting braces on the same line without spaces
• Omitting braces for single statements

3. What is the output of the following C code snippet?

int main() {
    int a = 5, b = 10;
    int sum = a + b;
    printf("Sum is %d\n", sum);
    return 0;
}

medium

A. Sum is 15

B. Sum is 510

C. Sum is a + b

D. Compilation error

Solution

1. Step 1: Understand variable initialization and addition

   Variables a and b are assigned 5 and 10, sum is their addition (5 + 10 = 15).

2. Step 2: Analyze printf output

   printf prints "Sum is " followed by sum's value, which is 15.

3. Final Answer:

   Sum is 15 -> Option A

4. Quick Check:

   5 + 10 = 15 output [OK]

Hint: Add variables before printing to get correct sum [OK]

Common Mistakes:

• Concatenating integers as strings
• Forgetting to add variables
• Syntax errors in printf format

4. Identify the readability issue in this C code and select the best fix:

int main(){int x=10;int y=20;if(x>y){printf("x is greater\n");}else{printf("y is greater\n");}return 0;}

medium

A. Use goto statements for flow control.

B. Remove all spaces to make it compact.

C. Change variable names to single letters.

D. Add spaces and line breaks for clarity.

Solution

1. Step 1: Analyze current formatting

   Code is cramped with no spaces or line breaks, making it hard to read.

2. Step 2: Suggest formatting improvements

   Adding spaces and line breaks separates statements and improves readability.

3. Final Answer:

   Add spaces and line breaks for clarity. -> Option D

4. Quick Check:

   Proper formatting improves readability [OK]

Hint: Use indentation and spaces to separate code blocks [OK]

Common Mistakes:

• Ignoring formatting leads to hard-to-read code
• Using goto increases complexity
• Making names less descriptive

5. You have a function that calculates the area of a rectangle:

float area(float w, float h){return w*h;}

How can you improve this code's readability for a team project?

hard

A. Use single-letter variable names to shorten code.

B. Remove the return statement to simplify.

C. Add descriptive comments and use meaningful parameter names.

D. Write the function in one line without spaces.

Solution

1. Step 1: Review current function

   Function uses short parameter names and no comments, which may confuse others.

2. Step 2: Suggest improvements

   Using descriptive names like width and height and adding comments clarifies purpose.

3. Final Answer:

   Add descriptive comments and use meaningful parameter names. -> Option C

4. Quick Check:

   Comments and clear names improve teamwork [OK]

Hint: Explain purpose with comments and clear names [OK]

Common Mistakes:

• Using vague parameter names
• Skipping comments
• Making code too compact