Code Smell 174 — Имя класса в атрибутах

Повторяющиеся имена — это плохой запах. Имена должны быть контекстными

TL;DR: не добавляйте к атрибутам префикс имени класса

Проблемы

• Неконтекстные имена

Решения

1. Удалить префикс класса из атрибута

Контекст

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

Образец кода

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

public class Employee {
   String empName = "John";
   int empId = 5;
   int empAge = 32;
}

Верно

public class Employee {
   String name;
   int id; // Ids are another smell
   int age; // Storing the age is yet another smell
}

Обнаружение

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

Когда полное имя включено в префикс, наши линтеры могут нас предупредить.

Теги

• Именование

Заключение

Тщательное именование — очень важная задача.

Нам нужно назвать поведение, а не тип или данные

связи

Больше информации

• Подсказка Линукса

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

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

Кредиты

Фото автора Phoenix Han на Unsplash

Копирование не дает понять. Понимание — это то, как вы растете. Вы должны понять, почему что-то работает или почему что-то так оно и есть. Когда вы копируете это, вы упускаете это. Вы просто переназначаете последний слой вместо того, чтобы разбираться во всех нижних слоях.

Джейсон Фрайд

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