ПЕРВЫЙ ШАГ К ЧИСТОМУ КОДУ
Привет, друзья! Сегодня затронем важную тему, а именно именование переменных в коде. Да, это действительно важно, думаю, вы понимаете почему. Программы, которые вы пишите, должны быть понятны не только вам, но и вашим коллегам. Существует несколько правил, которых желательно придерживаться при написании кода. Давайте обсудим их поподробнее…
✅ Наименование переменных. Базовая концепция, которую мы используем при именовании переменной: название переменной должно быть максимально полным и точным. Как себя проверить? Если мы возьмем только строку кода, где инициализируется переменная (не смотря на код, который идет выше или ниже), мы должны четко понимать, что же находится в этой переменной.
👁🗨Рассмотрим пример: допустим мы назвали переменную users. Хорошо это или плохо? Сразу же возникает вопрос: users -> пользователи, какие пользовали? Что их отличает друг от друга? Хорошо, если вы работаете над проектом, в котором используется только одна группа пользователей. А если вы пишите банковскую систему, где пользователем может быть и сотрудник, и клиент, и юридическое лицо… Вот это уже плохо. Разумнее было бы дать разным группам пользователей разные названия: employees, bank_customers, legal_entities… Надеюсь, с этой концепцией разобрались.
📌Важно не забывать: имена классов, модулей, переменных – существительные, имена методов и функций – глаголы.
⚠️ Когда вы перечитываете код, вы проговариваете имена переменных, методов, функций, поэтому не бойтесь длинных названий, не нужно слишком сильно сокращать нейминг. Он должен удобно произноситься и прочитываться.
⚠️ Аббревиатуры в коде. На мой взгляд, уместно использовать аббревиатуры, если это общепринятые названия. Если вы придумали только что аббревиатуру и решили так назвать переменную, кажется, это не очень хорошая идея.
✅ Комментарии в коде. Нужны ли они? Комментарии можно оставлять, когда важно донести смысл того или иного метода. Многие новички делают ошибку и прописывают комментарии почти над каждой строкой. Это выглядит примерно так: #здесь группируем юзеров по такому-то ключу. Скорее всего, такие комментарии не имеют смысл, ведь читающий код человек поймет это и без них.
✅ Пользуйтесь константами. Обозначайте константы в коде БОЛЬШИМИ_БУКВАМИ. Так ваш код будет выглядеть более читаемым.
Делитесь в комментариях правилами, которые помогают Вам писать читаемый код.
Привет, друзья! Сегодня затронем важную тему, а именно именование переменных в коде. Да, это действительно важно, думаю, вы понимаете почему. Программы, которые вы пишите, должны быть понятны не только вам, но и вашим коллегам. Существует несколько правил, которых желательно придерживаться при написании кода. Давайте обсудим их поподробнее…
✅ Наименование переменных. Базовая концепция, которую мы используем при именовании переменной: название переменной должно быть максимально полным и точным. Как себя проверить? Если мы возьмем только строку кода, где инициализируется переменная (не смотря на код, который идет выше или ниже), мы должны четко понимать, что же находится в этой переменной.
👁🗨Рассмотрим пример: допустим мы назвали переменную users. Хорошо это или плохо? Сразу же возникает вопрос: users -> пользователи, какие пользовали? Что их отличает друг от друга? Хорошо, если вы работаете над проектом, в котором используется только одна группа пользователей. А если вы пишите банковскую систему, где пользователем может быть и сотрудник, и клиент, и юридическое лицо… Вот это уже плохо. Разумнее было бы дать разным группам пользователей разные названия: employees, bank_customers, legal_entities… Надеюсь, с этой концепцией разобрались.
📌Важно не забывать: имена классов, модулей, переменных – существительные, имена методов и функций – глаголы.
⚠️ Когда вы перечитываете код, вы проговариваете имена переменных, методов, функций, поэтому не бойтесь длинных названий, не нужно слишком сильно сокращать нейминг. Он должен удобно произноситься и прочитываться.
⚠️ Аббревиатуры в коде. На мой взгляд, уместно использовать аббревиатуры, если это общепринятые названия. Если вы придумали только что аббревиатуру и решили так назвать переменную, кажется, это не очень хорошая идея.
✅ Комментарии в коде. Нужны ли они? Комментарии можно оставлять, когда важно донести смысл того или иного метода. Многие новички делают ошибку и прописывают комментарии почти над каждой строкой. Это выглядит примерно так: #здесь группируем юзеров по такому-то ключу. Скорее всего, такие комментарии не имеют смысл, ведь читающий код человек поймет это и без них.
✅ Пользуйтесь константами. Обозначайте константы в коде БОЛЬШИМИ_БУКВАМИ. Так ваш код будет выглядеть более читаемым.
Делитесь в комментариях правилами, которые помогают Вам писать читаемый код.