Используйте профессиональные и значимые имена
TL;DR: не будьте неформальными или оскорбительными
Проблемы
- Читабельность
- Непрофессиональная работа
Решения
1. Выбирайте хорошие и профессиональные имена.
Контекст
Наша профессия имеет творческую сторону.
Иногда нам становится скучно, и мы пытаемся быть забавными.
Образец кода
Неправильный
function erradicateAndMurderAllCustomers(); //unprofessional and offensive
Верно
function deleteAllCustomers(); //more declarative and professional
Обнаружение
[X] Полуавтоматический
У нас может быть список запрещенных слов.
Мы также можем проверить их в обзорах кода.
Имена зависят от контекста, поэтому для автоматического линтера это будет сложной задачей.
Соглашения об именах должны быть общими и не должны включать культурный жаргон.
Теги
- Именование
Заключение
Будьте профессиональны в том, как вы называете вещи в своем коде.
Не пытайтесь быть комиком, давая переменной глупое имя.
Вы должны писать производственный код, чтобы будущие разработчики программного обеспечения (даже вы) могли его легко понять.
связи
Больше информации
Этот менталитет Gnome «пользователи — идиоты, и их смущает функциональность» — болезнь. Если вы думаете, что ваши пользователи идиоты, только идиоты будут его использовать.
Линус Торвальдс
Эта статья является частью серии CodeSmell.
