Improving code readability - Cheat Sheet & Quick Revision

Recall & Review

beginner

Why is using meaningful variable names important?

Meaningful variable names help others and your future self understand what the code does without guessing. It makes the code clearer and easier to follow.

beginner

What is the benefit of adding comments in your C code?

Comments explain why the code does something, not just what it does. They help readers understand the purpose and logic behind the code, especially complex parts.

beginner

How does consistent indentation improve code readability?

Consistent indentation shows the structure of the code clearly. It helps readers see which code belongs inside loops, conditions, or functions, making it easier to follow.

intermediate

What is the purpose of breaking code into smaller functions?

Smaller functions do one thing well. This makes code easier to test, understand, and reuse. It also reduces repetition and clutter in the main code.

intermediate

Why should magic numbers be avoided in code?

Magic numbers are unexplained numbers in code. They confuse readers. Using named constants instead explains what the number means and makes the code easier to change.

Which practice improves code readability the most?

A Writing all code in one long function

B Using random indentation

C Avoiding comments

D Using meaningful variable names

Meaningful variable names make code easier to understand. Writing all code in one function or avoiding comments makes it harder to read.

What does consistent indentation help show in C code?

A The memory usage

B The structure and blocks of code

C The size of variables

D The speed of the program

Indentation visually shows which code belongs inside loops, conditions, or functions, clarifying the program's structure.

Why should you avoid magic numbers in your code?

A They make code confusing and hard to maintain

B They make the program run slower

C They increase the file size

D They cause syntax errors

Magic numbers are unexplained values that confuse readers. Using named constants clarifies their meaning.

What is a good reason to add comments in your code?

A To replace meaningful variable names

B To make the code run faster

C To explain why the code does something

D To increase the number of lines

Comments help explain the purpose and logic behind code, making it easier to understand.

Breaking code into smaller functions helps by:

A Making code easier to understand and reuse

B Making the program use more memory

C Making the code longer and complex

D Reducing the number of variables

Smaller functions focus on one task, improving clarity and reusability.

List three ways to improve code readability in C.

Think about how to make code easier to understand for others.

Explain why breaking code into smaller functions helps readability.

Consider how smaller pieces make a big task simpler.

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