КОД ЗАПАХ 159 — MIXED_CASE

Серьезной разработкой занимаются разные люди. Мы должны начать соглашаться.

TL;DR: не смешивайте разные преобразования регистра

Проблемы

• Читабельность
• Ремонтопригодность

Решения

1. Выберите стандарт корпуса
2. Держись за это

Контекст

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

Одни предпочитают camelCase🐫, другие — snake_case🐍, MACRO_CASE🗣️ и многие другие.

Код должен быть простым и читаемым.

Образец кода

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

{
    "id": 2,
    "userId": 666, 
    "accountNumber": "12345-12345-12345",
    "UPDATED_AT": "2022-01-07T02:23:41.305Z",
    "created_at": "2019-01-07T02:23:41.305Z",
    "deleted at": "2022-01-07T02:23:41.305Z"
}

Верно

{
    "id": 2,
    "userId": 666, 
    "accountNumber": "12345-12345-12345",
    "updatedAt": "2022-01-07T02:23:41.305Z",
    "createdAt": "2019-01-07T02:23:41.305Z",
    "deletedAt": "2022-01-07T02:23:41.305Z"
  // This doesn't mean THIS standard is the right one
}

Обнаружение

[Х] Автоматически

Мы можем рассказать нашим линтерам о широких стандартах именования нашей компании и обеспечить их соблюдение.

Всякий раз, когда в организацию приходит новый человек, автоматизированный тестировщик должен вежливо попросить его/ее/.. изменить код.

Исключения

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

Теги

• Именование

Заключение

Работать со стандартами легко.

Нам нужно обеспечить их выполнение.

связи

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

Все соглашения об именах

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

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

Кредиты

Фото Wolfgang Hasselmann на Unsplash

Если у вас слишком много особых случаев, вы делаете это неправильно.

Крейг Зеруни

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