Code inspection: Add explicit 'return' or 'continue' before local functions

tip

You can suppress this inspection to ignore specific issues, change its severity level to make the issues less or more noticeable, or disable it altogether.

When you have one or more local functions defined at the end of a method, JetBrains Rider suggests adding an explicit return between the last executable statement and the local function definition. The method will return at that point anyway, but making this explicit will enhance the clarity of the method's control flow for readers. This is particularly beneficial if the local function definition is lengthy, or if there are multiple local functions. In these instances, the reader will not have to scroll to the end of the method to check for more executable statements after the local function definitions.

Here is an example:

void Process(string[] lines)
{
    foreach (var line in lines)
    {
        if (IsValid(line))
        {
            Console.WriteLine(line);
        }
    }
    Console.WriteLine("finishing");
    bool IsValid(string str)
    {
        return str.Length > 0;
    }
}

void Process(string[] lines)
{
    foreach (var line in lines)
    {
        if (IsValid(line))
        {
            Console.WriteLine(line);
        }
    }
    Console.WriteLine("finishing");
    return;
    bool IsValid(string str)
    {
        return str.Length > 0;
    }
}

The same applies when a local function is defined inside a block. In such cases, adding an explicit continue statement makes the structure of the block more comprehensible:

void Process(string[] lines)
{
    foreach (var line in lines)
    {
        if (IsValid(line))
        {
            Console.WriteLine(line);
        }
        bool IsValid(string str)
        {
            return str.Length > 0;
        }
    }
}

void Process(string[] lines)
{
    foreach (var line in lines)
    {
        if (IsValid(line))
        {
            Console.WriteLine(line);
        }
        continue;
        bool IsValid(string str)
        {
            return str.Length > 0;
        }
    }
}