Improving code readability - Mini Project: Build & Apply

Improving code readability

📖 Scenario: You are working on a simple program that calculates the area of rectangles. The original code is hard to read because it uses unclear variable names and lacks spacing.

🎯 Goal: You will improve the code readability by using clear variable names, adding spacing, and organizing the code neatly. This will make the program easier to understand and maintain.

📋 What You'll Learn

Create variables with clear and descriptive names

Use proper spacing around operators

Calculate the area by multiplying width and height

Print the results clearly

💡 Why This Matters

🌍 Real World

Clear and readable code is important in real projects so that teammates and future you can easily understand what the program does.

💼 Career

Employers value programmers who write clean, readable code because it reduces bugs and makes collaboration easier.

1

Create variables for rectangle dimensions

Create two integer variables called width and height and set them to 5 and 10 respectively.

C

// Create two integer variables called width and height and set them to 5 and 10 respectively
// Your code here

Hint

Use int width = 5; and int height = 10; to create the variables.

2

Add a variable for area calculation

Add an integer variable called area and initialize it to 0.

C

#include 

int main() {
    int width = 5;
    int height = 10;
    // Add an integer variable called area and initialize it to 0
    // Your code here
    return 0;
}

Hint

Use int area = 0; to create the area variable.

3

Calculate the area using clear expressions

Calculate the area by multiplying width and height and store the result in area. Use spaces around the multiplication operator.

C

#include 

int main() {
    int width = 5;
    int height = 10;
    int area = 0;
    // Calculate the area by multiplying width and height
    // Your code here
    return 0;
}

Hint

Write area = width * height; with spaces around the *.

4

Print the area with a clear message

Print the text "Area of rectangle: " followed by the value of area using printf. Use a newline at the end.

C

#include 

int main() {
    int width = 5;
    int height = 10;
    int area = 0;
    area = width * height;
    // Print the area with a clear message
    // Your code here
    return 0;
}

Hint

Use printf("Area of rectangle: %d\n", area); to print the result.

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