Названия в коде, который переживёт вас
В системах, живущих десятилетиями, имена читают люди, которые никогда вас не видели.
Что работает. Название по смыслу, а не по технической природе. Функция называется по результату. Логическое значение — утверждением, чтобы условие читалось фразой.
Чего избегать. Сокращений, понятных только вашему отделу. Слов-пустышек: данные, объект, обработчик. Названий, которые врут: функция «получить» не должна ничего менять.
Отдельная беда промышленных систем — унаследованные аббревиатуры из бумажных форм. Если поле называется так, оставьте расшифровку в комментарии: через десять лет спросить будет не у кого.
Полезный приём: если имя не придумывается, обычно сущность делает слишком много и её пора делить. Трудность с названием — диагноз архитектуры.
И правило единообразия: смесь транслитерации и английского в одном проекте ломает поиск по коду, а поиск — главный инструмент того, кто разбирается в чужой системе.
IT Сургут — t.me/surgut_it
IT Сургут
@surgut_it
Названия в коде, который переживёт вас
Этот пост опубликован в Telegram-канале IT Сургут. Подписаться можно по ссылке: @surgut_it.