Coding Review & Refactor

Real coders rarely get the code right on the first try. They write something that works, then come back and clean it up. That second pass is called a refactor — same behavior, better code. Refactoring is how a good program turns into a great one.

What is a Code Smell?

A code smell is a hint that something inside your program is messier than it needs to be. The code might still run — but it is hard to read, hard to fix, and easy to break. Code smells do not mean you wrote bad code. They mean it is time for a polish.

• Repeating the same lines — three identical print statements in a row.
• Magic numbers — a value like 86400 sitting in the code with no name.
• Long scripts — one giant block of code that does five different jobs.
• Confusing names — variables called x, y, and tmp instead of speed or score.
• Dead code — old lines that are never used or always skipped.
• Nested if-if-if — checks tucked three levels deep that are hard to follow.

The Refactor Moves

Each code smell has a simple fix. You do not rewrite the whole program — you make small, safe moves and run the program after each one to make sure nothing broke.

1. Repeating lines → wrap them in a loop.
2. Magic numbers → store them in a named constant like SECONDS_PER_DAY.
3. Long scripts → split them into small functions, each doing one job.
4. Confusing names → rename variables and functions to say what they mean.
5. Dead code → delete it — a saved copy of your project still has the old lines.
6. Nested ifs → check the special case first and stop early (an early return), so the checks do not pile up.

The Refactor Loop

1. Read your code out loud — the parts you stumble over are clues.
2. Pick ONE smell to fix first. Small steps beat big rewrites.
3. Make the change.
4. Run the program (or its tests) to check it still works.
5. Repeat until the code reads cleanly. Then stop — done is done.