Follow

Follow
Code Smell 188 - Redundant Parameter Names

Photo by Wolfgang Hasselmann on Unsplash

Code Smell 188 - Redundant Parameter Names

Use contextual and local names

Maxi Contieri⭐⭐⭐'s photo
Maxi Contieri⭐⭐⭐
·Dec 24, 2022·

1 min read

Play this article

Table of contents

  • Problems
  • Solutions
  • Context
  • Sample Code
  • Detection
  • Tags
  • Conclusion
  • Relations
  • Disclaimer
  • Credits

TL;DR: Don't repeat your parameters' names. Names should be contextual.

Problems

  • Duplication

  • Readability

Solutions

  1. Remove the repeated part from the name

Context

When using names, we often miss that words are contextual and need to be read as a whole sentence.

Sample Code

Wrong

class Employee
  def initialize(@employee_first_name : String, @employee_last_name : String, @employee_birthdate : Time)
  end
end

Right

class Employee
  def initialize(@first_name : String, @last_name : String, @birthdate : Time)
  end
end

Detection

[X] Semi-Automatic

We can check our parameter names and try to find duplication.

Tags

  • Naming

Conclusion

Use short and contextual names for your parameters.

Relations

Disclaimer

Code Smells are just my opinion.

Credits

Photo by Wolfgang Hasselmann on Unsplash


As a rule, software systems do not work well until they have been used, and have failed repeatedly, in real applications.

David Parnas


This article is part of the CodeSmell Series.

 
Share this