Code Smell 188 — Избыточные имена параметров

Используйте контекстные и локальные имена

TL;DR: не повторяйте названия параметров. Имена должны быть контекстными.

Проблемы

• Дублирование
• Читабельность

Решения

1. Удалить повторяющуюся часть имени

Контекст

При использовании имен мы часто упускаем из виду, что слова зависят от контекста и их нужно читать как целое предложение.

Образец кода

Неправильный

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

Верно

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

Обнаружение

[X] Полуавтоматический

Мы можем проверить наши имена параметров и попытаться найти дублирование.

Теги

• Именование

Заключение

Используйте короткие и контекстные имена для ваших параметров.

связи

Отказ от ответственности

Code Smells — это всего лишь мое мнение.

Кредиты

Фото Wolfgang Hasselmann на Unsplash

Как правило, программные системы не работают должным образом до тех пор, пока они неоднократно не использовались в реальных приложениях.

Дэвид Парнас

Эта статья является частью серии CodeSmell.