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