Reading a book using a finger

I stopped using leading or tricky questions in Code Reviews

This post is part of my Advent of Code 2022.

Recently, I have found posts online suggesting “leading” questions during code reviews to make the reviewee change something about his code. This is what I’ve learned to do instead.

During code reviews, don’t use leading questions to suggest code changes. Instead, leave unambiguous comments and distinguish between questions, actionable items, and nice-to-haves.

Don’t use leading questions to ask for changes

For example, let’s imagine we wrote a method and forgot to check for nulls. Something like this,

public void DoSomething(OneParam oneParam, AnotherParam anotherParam)
{
    var anything = UsingOneParam(oneParam.SomeProperty);
    // ...
}

If our reviewer follows that advice to use “pushy” questions, we could receive comments like “what if oneParam is null?” or “could oneParam or anotherParam be null?

I don’t like these comments. We can’t tell if they’re genuine questions or actionable items. Is the reviewer asking a clarification question or “pushing” us in a different direction?

We can reach out to the reviewer via email or chat to ask him to further explain his intention. But what if we and our reviewer are in different time zones? Or parts of the world? Any interaction will take about 24 hours between our message asking for clarification and an answer from the reviewer. It’s frustrating and time-consuming. Arrrggg!

The Thinker
That's a tricky question. Let me think about it. Photo by Tingey Injury Law Firm on Unsplash

Use unambiguous and intentional comments

Instead of leading or pushy questions, let’s leave unambiguous comments. Also, let’s distinguish between questions, actionable items, and nice-to-haves.

Let’s go back to the previous example and leave an unambiguous comment. Like this one: “is it possible that oneParam could be null? If that’s the case, please let’s add the appropriate null checks. Something like if (oneParam == null) throw ... With this comment, it’s clear we’re suggesting a change.

We can show the intention of our comments using Conventional Comments. With this convention, we add keywords like “question,” “suggestion” or “nitpick” to show what we meant with our comments. I’ve been using it for months in one of my client’s projects and I’ve seen how other reviewers have started to pick it too.

For example, we can turn our previous comment into these two depending on our intention:

Now it’s clear the reviewer meant two different things.

Voilà! That’s why I don’t like “leading” questions in code reviews. Let’s always prefer clear and unambiguous comments. And, let’s show the intention behind them. We can review code from people with different experience levels and even non-native speakers of our language.

Ah! Another thing, let’s not forget about the magic word when writing comments: “please.”

If you want to read more about code reviews, check these Tips and Tricks for Better Code Reviews. Some of them are my own lessons and others are what I’ve found online.

Happy coding!