Functions and block parameters should be named consistently to communicate intent and improve maintainability. Rename your function or block parameter 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.
Functions and block parameters 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 function and block parameter names match a provided regular expression.

What is the potential impact?

Inconsistent naming of functions and block parameters can lead to several issues in your code:

• Reduced Readability: Inconsistent function and block parameter names make the code harder to read and understand; consequently, it is more difficult to identify the purpose of each variable, spot errors, or comprehend the logic.
• Difficulty in Identifying Variables: The functions and block parameters that don’t adhere to a standard naming convention are challenging to identify; thus, the coding process slows down, especially when dealing with a large codebase.
• Increased Risk of Errors: Inconsistent or unclear function and block parameter names lead to misunderstandings about what the variable represents. This ambiguity leads to incorrect assumptions and, consequently, bugs in the code.
• Collaboration Difficulties: In a team setting, inconsistent naming conventions lead to confusion and miscommunication among team members.
• Difficulty in Code Maintenance: Inconsistent naming leads to an inconsistent codebase. The code is difficult to understand, and making changes feels like refactoring constantly, as you face different naming methods. Ultimately, it makes the codebase harder to maintain.

In summary, not adhering to a naming convention for functions and block parameters 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 ^(@{0,2}[\da-z_]+[!?=]?)|([*+-/%=!><~]+)|(\[]=?)$:

def show_something(text_Param) # Noncompliant
  localVar = "" # Noncompliant
  puts text_Param + localVar
end

Compliant solution

def show_something(text_param)
  local_var = ""
  puts text_param + local_var
end

Resources

Documentation

• Wikipedia - Naming Convention (programming)

Related rules

• {rule:ruby:S100} - Method names should comply with a naming convention
• {rule:ruby:S101} - Class names should comply with a naming convention