Советы по написанию качественного кода.
Идея написания статьи возникла закономерно после того, как я прочитал книги “Clean Code” и “The Clean Coder”. До знакомства с этими книгами я считал, что для того, чтобы быть хорошим разработчиком, нужно много знать о коде — знать много языков программирования, много фреймворков, много библиотек… Однако после прочтения этих книг я понял, что:
“Если вы хотите стать профессиональным разработчиком, то помимо изучения чего-то нового, вы еще должны уметь писать простой и структурированный код.”
Я думаю, что именно эта способность отличает мидла от сеньора. Теперь, в этой статье, я хочу показать вам свое руководство к действию: как писать простой и чистый код, с помощью нескольких очень простых примеров.
Когда вы начнете следовать этим «правилам», то в скором времени вы заметите важность написания чистого кода и пересмотрите свои предыдущие проекты.
Имена переменных должны быть как можно короче и в то же время максимально информативны.
Вот вам пример с очень плохими названиями переменных. Имена короткие, но совсем не описательные.
Надеюсь, ваш код намного лучше😃.
Это код уже намного лучше. Когда вы его читаете, то как минимум понимаете, что происходит.
Большинство людей с первого взгляда не смогут понять, что обозначают 12, 30 и 24.
В этом коде больше строк, однако он более читабельный.
Используйте одинаковый шаблон именования для переменных одинакового типа.
Это была моя частая ошибка, когда я только начинал свой путь программиста. Отсутствие повторений — важная вещь при написании чистого кода. По возможности старайтесь избегать дублирования кода.
Пример:
Приведенный выше код можно легко улучшить — нужно просто добавить к функции еще один аргумент.
Такое улучшение кода может сделать его более гибким и читабельным.
Эти условные выражения проверяют одно и то же, но разными способами. Выбор всегда за вами, но я надеюсь большинство понимает, что положительные условные выражения, как минимум, быстрее отрицательных.
Это «правило» довольно популярно, и я думаю, что многие из вас слышали о нем.
Я знаю, что быстрее написать код, не разбивая его на более мелкие функции, но поверьте, оно того стоит. Благодаря разбиению вы сможете легко ориентироваться в коде. *Еще один плюс в том, что функции могут быть универсальными.
Не переназначайте переменные. Если вы пишете код на JavaScript, по возможности используйте const
вместо let
. Если вы хотите изменить значение переменной, измените его, а затем подумайте о будущем использовании этой переменной. Лучше создать еще одну переменную и присвоить ей новое значение.
На левой картинке показана проблема переназначения переменной. Мы изменяем строковую переменную name и присваиваем ей массив.
А вот что, если мы будем использовать его в других местах как строку? Мы получим ошибку или, что еще хуже, все будет работать, как обычно, и мы не сможем понять, почему наша программа не работает должным образом. На правой картинке у нас есть две отдельные переменные, поэтому все хорошо и ошибок возникнуть не должно.
*Использование const в Javascript поможет вам избежать подобной ошибки. Окей, я рекомендую вам прочитать книги «The Clean Code» и «Сlean Code». Надеюсь, что моя статья приблизит вас к качественному коду. 😉