Код Запах 163 — Коллекция в названии

Вы когда-нибудь видели CustomerCollection?

TL;DR: не используйте слово «коллекция» в своем имени. Это слишком абстрактно для конкретных понятий.

Проблемы

• Читабельность
• Злоупотребление абстракцией
• Плохое название

Решения

1. Переименуйте коллекцию с определенным именем.

Контекст

Именование очень важно.

Нам нужно много работать с коллекциями.

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

Пустая коллекция полиморфна полной коллекции.

Мы избегаем нулей и если.

Мы часто используем плохие и расплывчатые имена вместо того, чтобы искать хорошие имена в MAPPER.

Образец кода

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

foreach (var customer in customerCollection)
{
    // iterate with current customer
}
foreach (var customer in customersCollection)
{
    // iterate with current customer
}

Верно

foreach (var customer in customers)
{
    // iterate with current customer
}

Обнаружение

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

Все линтеры могут обнаруживать такие плохие имена.

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

Теги

• Именование

Заключение

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

Точные имена необходимы для понимания нашего кода.

связи

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

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

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

Кредиты

Фото Mick Haupt на Unsplash

Закон Альцгеймера в программировании: смотреть на код, который вы написали более двух недель назад, все равно, что смотреть на код, который вы видите впервые.

Дэн Хурвиц

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