Освоение соглашений об именах Kotlin: преодоление абстрактных имен

Проблема

Реализованное именование
Бессмысленные имена
Сломанный MAPPER и Bijection для объектов реального мира.

Решение

Выбирайте осмысленные имена.
Найдите метафоры.
Избегайте таких слов, как абстрактный, базовый, общий, помощник, данные, информация и т. д.
Используйте правила для именования.

Образец кода

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

class Repository {
    // ...
}

class MeetingCollection {
    // ...
}

class AccountsComposite {
    // ...
}

class NoteArray {
    // ...
}

class LogCollector {
    // ...
}

abstract class SearcherBase {
    // ...
}

abstract class AbstractTransportation {
    // ...
}

Верно

class Schedule {
    // ...
}

class Portfolio {
    // ...
}

class NoteBook {
    // ...
}

class Journal {
    // ...
}

class Vehicle {
    // ...
}

Заключение

Поиск имен — это последнее, что мы должны делать в наших проектах. Если у нас нет четкого понимания бизнеса, хорошие имена появляются в конце после определения границ поведения и протокола.

Надеюсь, вам понравилось это путешествие и вы узнали что-то новое. Если вы хотите быть в курсе моих последних мыслей и идей, не стесняйтесь подписаться на мою информационную рассылку. Вы также можете найти меня в LinkedIn или Twitter. Оставайтесь на связи и продолжайте общение!

Кредиты

Code Smell 38 — Abstract Names Максимилиано Контьери

Первоначально опубликовано на https://yonatankarp.com.

Спасибо, что дочитали до конца. Пожалуйста, следите за автором и этой публикацией. Посетите Stackademic, чтобы узнать больше о том, как мы демократизируем бесплатное обучение программированию по всему миру.