Use contextual and local names

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

Code Smell 87 - Inconsistent Parameters Sorting

Maxi Contieri ・ Sep 26 '21

#programming #webdev #codenewbie #functional

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

Software Engineering Great Quotes

Maxi Contieri ・ Dec 28 '20

#codenewbie #programming #quotes #software

This article is part of the CodeSmell Series.

How to Find the Stinky parts of your Code

Maxi Contieri ・ May 21 '21

#codenewbie #tutorial #codequality #beginners