Local variables should be named consistently to communicate intent and improve maintainability. Rename your local variable to follow your project’s naming convention to address this issue.

Why is this an issue?

A naming convention in software development is a set of guidelines for naming code elements like variables, functions, and classes.
Local variables hold the meaning of the written code. Their names should be meaningful and follow a consistent and easily recognizable pattern.
Adhering to a consistent naming convention helps to make the code more readable and understandable, which makes it easier to maintain and debug. It also ensures consistency in the code, especially when multiple developers are working on the same project.

This rule checks that local variable names match a provided regular expression.

What is the potential impact?

Inconsistent naming of local variables can lead to several issues in your code:

In summary, not adhering to a naming convention for local variables can lead to confusion, errors, and inefficiencies, making the code harder to read, understand, and maintain.

How to fix it

First, familiarize yourself with the particular naming convention of the project in question. Then, update the name to match the convention, as well as all usages of the name. For many IDEs, you can use built-in renaming and refactoring features to update all usages at once.

Code examples

Noncompliant code example

With the default regular expression ^[a-z][a-z0-9]*([A-Z]{1,3}[a-z0-9]+)*([A-Z]{2})?$, bringing the following constraints:

Module Module1
    Sub Main()
        Dim Foo = 0 ' Noncompliant
    End Sub
End Module

Compliant solution

Module Module1
    Sub Main()
        Dim foo = 0 ' Compliant
    End Sub
End Module

Resources

Documentation

Related rules