Запах кода 153 — Слишком длинные имена

Имена должны быть длинными и описательными. Насколько длинными?

TL;DR: Имена должны быть достаточно длинными. Не длиннее.

Проблемы

  • Читабельность

  • Когнитивная нагрузка

Решения

  1. Используйте названия, связанные с КАРТОГРАФОМ

Контекст

В 50-е и 60-е годы мы использовали очень короткие имена из-за нехватки места и времени.

В современных языках это уже не так.

Иногда мы слишком увлекаемся.

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

Образец кода

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

PlanetarySystem.PlanetarySystemCentralStarCatalogEntry

// Redundant
Войти в полноэкранный режим Выйти из полноэкранного режима

Правильно

PlanetarySystem.CentralStarCatalogEntry
Войти в полноэкранный режим Выход из полноэкранного режима

Обнаружение

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

Наши литеры могут предупреждать нас о слишком длинных именах.

Теги

  • Блутеры

  • Именование

Заключение

Не существует жестких правил относительно длины имен.

Только эвристика.

Отношения

Запах кода 33 — Аббревиатуры

Maxi Contieri ・ Nov 24 ’20 ・ 2 min read

#oop #codenewbie #программирование #учебник

Дополнительная информация

  • Что такое имя? — Часть I: Поиск

  • Что такое имя? — Часть II: Реабилитация

  • Долго и коротко об именовании

Кредиты

Фото Emre Karataş on Unsplash


Многие люди склонны рассматривать стили программирования и языки как религии: если вы принадлежите к одной, то не можете принадлежать к другим. Но эта аналогия — очередное заблуждение.

Никлаус Вирт

Программная инженерия Великие цитаты

Maxi Contieri ・ Dec 28 ’20 ・ 13 min read

#codenewbie #программирование #цитаты #программное обеспечение

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

Как найти зловонные части вашего кода

Maxi Contieri ・ May 21 ’21 ・ 7 min read

#codenewbie #учебник #качество кода #новички

Оцените статью
devanswers.ru
Добавить комментарий