Code Readability

Let’s look at how to improve code readability in code reviews. We’ll show you a simple example and explain why the feedback matters.

The Scenario

A developer has written code to check if a user is eligible to drive. The code works but could be more readable.

// Before
function canDrive(user) {
  return (
    user.age >= 16 &&
    user.hasLicense &&
    !user.isSuspended &&
    user.visionTestPassed &&
    user.medicalCheckPassed
  )
}

PR Comment

Choose the comment that you think is the most constructive and helpful.

Melamie Chocolatecommented on Apr 2, 2025

This code is unreadable. You need to make it clearer.

🚫

Less Helpful Approach

• Non-specific and unclear on what improvements are needed
• Puts unnecessary pressure without providing a constructive direction
• Does not facilitate actionable changes

Iormina Azurecommented on Apr 2, 2025

Thanks for implementing the driving eligibility check! Breaking down the condition into descriptive variables makes the code’s intent much clearer. This helps other developers understand the business logic more easily. Here’s how we can improve it:

drivingEligibility.ts

// After
function canDrive(user) {
  const meetsAgeRequirement = user.age >= 16;
  const hasValidLicense = user.hasLicense && !user.isSuspended;
  const passedRequiredTests = user.visionTestPassed && user.medicalCheckPassed;
 
  return meetsAgeRequirement && hasValidLicense && passedRequiredTests;
}