Несколько рекомендаций, как разрабатывать понятные имена для программных объектов:
- Придерживаться общепринятых соглашений. 1 Стоит ознакомиться с соглашениями об именовании для используемого языка или фреймворка и следовать им. 1
- Создавать уникальные имена. 2 Они выделяются на фоне других и позволяют не перепутать разные концепции, имеющие поверхностное сходство. 1
- Использовать «говорящие» имена. 4 Их следует образовывать от терминов предметной области таким образом, чтобы из имени было понятно назначение. 4
- Соблюдать баланс между информативностью и длиной имени. 2 Слишком короткие имена страдают от недостатка смысла, а слишком длинные растягивают программу, не добавляя читабельности. 5
- Избегать неинформативных имён. 2 К ним относятся названия, состоящие из одной-двух букв, созданные с добавлением порядкового числа на конце и не имеющие конкретной привязки к области применения. 2
- Не использовать сокращения и аббревиатуры. 2 С одной стороны, это уникальные названия, которые легко распознаются глазом, быстро пишутся, с другой — для стороннего читателя такие сокращения могут оказаться непонятными. 2
- Минимизировать или исключать имена с отрицаниями. 2 При чтении кода разработчику придётся выполнять двойную работу: вспоминать действительное значение переменной и сопоставлять с отрицаемой. 2
Также важно понимать, что именование переменных может отличаться для разных парадигм программирования. 3