Как в программировании быстро придумать правильные названия переменных, функций, классов, свойств, методов и т.д.

10.05.20 ИТ / Разное 5229

При написании программного кода часто возникает необходимость придумывать множество различных имен для всевозможных сущностей в программировании (в данной статье примеры будут на языке PHP), будь то переменные, функции, классы, свойства, методы и т.д. (далее просто «переменная»). Это относится к самым разным языкам программирования, ведь правильные имена позволят читать и редактировать код гораздо продуктивнее.

Начинающие разработчики часто спрашивают, как начать программировать правильно. Они часто называют переменные не самым лучшим способом, зачастую это просто бессмысленные названия, из-за которых читаемость кода значительно падает. По мере приобретения опыта разработчику становится понятно, что необходим тщательно проектировать свой код – правильно придумывать названия для своих переменных. Придумывание правильных имен может занять время, но с опытом программист делает это гораздо быстрее.

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

Например, на языке PHP он может писать так:

– переменные как $a = , $b = 1;

– функции как function get($a) { … }, function set($b) { … };

– имена классов class a { ... }, class b { ... } и т.д.

Очевидно, что код будет непонятен, ведь именования бессмысленные. Следует также избегать абстрактных именований вида: $data, $value и т.д. Названия переменных необходимо придумывать со смыслом, чтобы конкретный элемент в коде строго обозначал что-то. Имена не должны быть слишком длинные или короткие, лучше всего использовать английские значения, так как программирование базируется на иностранном языке. Использование транскрипции при написании кода не самый лучший вариант.

Как научиться придумывать правильные имена на лету? Можно использовать поэтапный подход:

– Для начала необходимо подумать, что будет обозначать создаваемая переменная и нужна ли она вообще. Часто бывает, что без переменной можно легко обойтись;

– Если переменная нужна и придумано ее назначение – можно мысленно подобрать 2-3 подходящих слова на своем родном языке. Затем вспомнить или посмотреть аналоги на английском языке;

– Когда слова получены следует остановить выбор на более подходящем слове – таком, чтобы оно читалось легко и код выглядел лаконично.

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

Важно понимать, что именование переменных может отличаться для разных парадигм программирования, например, объектно-ориентированный стиль позволяет гораздо легче писать имена. Процедурный стиль требует придумывать имена с префиксами, суффиксами для переменных и т.д.

Например, необходимо придумать имя для переменной, которое будет обозначать объект и его разновидности. Для переменной в процедурном стиле, которая будет обозначать ученика можно придумать слово «обучающийся», на английском можно использовать слово «learner». Но обычно нужно не только придумать одну переменную, но и похожие переменные. Это может быть:

– $learner_id – идентификатор обучающегося,

– $learner_name – имя обучающегося,

– $learner_age – возраст обучающегося и т.д.

В объектно-ориентированном программировании (ООП), эта задача решается легче, создается объект «learner» и используются его свойства:

– $learner->id;

– $learner->name;

– $learner->age и т.д.

Еще немаловажно придерживаться используемого в проекте стиля кодирования. Если код пишется с «нуля», тогда необходимо заранее решить какой стиль будет использоваться и применять его для всех переменных. Не стоит смешивать разные стили, например, чтобы переменные не выглядели так:

– $learnerId,

– $learnerAGE,

–$learner_Name и т.д.

Лучше использовать полные имена и не прибегать к сокращениям наподобие:

– $learn_id,

– $learn_ag и т.д.

У каждого языка есть свои плюсы и минусы, включая PHP. Хотя в самом языке PHP встречаются имена функций и переменных в сокращенном виде (даже на клавиатуре есть сокращения), но такие аббревиатуры являются общепринятыми и уместны для узких областей применения.

Таким образом, качество программного кода напрямую зависит от многих параметров, важным из которых является выбор парадигмы программирования и правильное именование переменных. В статье в основном рассмотрены примеры для переменных, но те же правила справедливы и для других сущностей.