Улучшите качество своего кода на 80 %, затрачивая 20 % усилий.
Когда мне отказали на моем первом собеседовании, я решил, что буду настолько хорош, что они не смогут меня игнорировать. Одной из вещей, которые я сделал, было чтение Чистый код. В этой книге я нашел большинство навыков кодирования, которые делают мой код более профессиональным (учитывая, что я все еще младший разработчик).
Вы все еще можете глупо читать книгу, которая учит вас писать хороший код. «Я способен решить любую проблему с помощью своего кода», подумаете вы прямо сейчас, но позвольте мне открыть вашу неприглядную правду…
Только решение проблемы — это первая часть развития.
Да, я усвоил этот урок из двух первых отказов на собеседовании. Каждый может решить проблему, но не каждый может написать удобочитаемый, эффективный и удобный для сопровождения код, понятный другим разработчикам.
По этой причине, если мы хотим стать разработчиками, важно найти передовой опыт в таких книгах, как Чистый код.
Что такое чистый код?
Чистый код — это книга, написанная Робертом К. Мартином, в которой предлагается философия Чистого кода. Эта философия определяет Чистый Код как:
Код, который легко понять, легко изменить и легко поддерживать.
В этой книге мы можем найти набор принципов написания кода, который легко понять и модифицировать.
Это правда, что мы пишем код, который будет выполняться компьютером. Однако мы люди, и мы должны сотрудничать с другими людьми в команде, чтобы создать большую часть программного обеспечения. На самом деле мы не разрабатываем код для компьютера, потому что компьютер его поймет, даже если мы пишем спагетти-код, мы пишем код для других людей.
Писать код для людей непросто. Когда мы начинаем разработку, мы думаем, что хорошим фрагментом кода будет тот, который действительно сложен и решает проблему, используя алгоритм, понятный только нам. Но на самом деле, и это то, что делают старшие инженеры, простой код лучше, чем сложный.
«Недостаточно, чтобы код работал». - Роберт С. Мартин
Итак, если мы хотим стать лучше как разработчики, мы должны приобрести передовой опыт и начать писать чистый код.
Если вы хотите узнать больше о том, как можно улучшить свой код, в этой статье вы найдете очень интересные принципы:
Из этой книги я мог извлечь много хороших практик и новый подход к объектно-ориентированному программированию. Тем не менее, я поделюсь с вами тремя простыми приемами, которые помогут улучшить качество вашего кода, приложив минимум усилий.
1. Правильно называйте свои переменные
В программировании у нас есть понятие переменные. Используя переменные, мы можем использовать имена вместо адресов памяти. Почему? Потому что имена просты в использовании, а адреса памяти нет. Кроме того, с помощью имени мы можем получить много информации о содержимом этой переменной вместо адреса памяти.
Для этого важно, чтобы мы не упустили эту возможность и не назвали плохие имена. Потому что использование плохого имени похоже на использование адреса памяти для имени переменной: что-то невозможное для понимания и нечитаемое.
Чтобы правильно называть наши переменные, мы должны помнить о некоторых рекомендациях:
- Имя должно сообщать вам, почему оно существует, что делает и как используется.
- Старайтесь избегать дезинформации (если вы используете строго типизированный язык, вам не нужно указывать тип в имени переменной).
- Используйте произносимые имена.
- Используйте доступные для поиска имена.
- Будьте последовательны в своем коде. Если вы всегда используете is для начала имени логической переменной, постарайтесь сохранить согласованность.
У вас уже есть какие-то сомнения? Давайте посмотрим на несколько примеров хорошего и плохого именования:
Пример JavaScript
2. Сведите количество параметров к минимуму
Аргументы затрудняют чтение и понимание функции. Чем больше аргументов, тем труднее управлять нашей функцией. Они сложнее с точки зрения тестирования (если вы не понимаете этого пункта — посмотрите мою статью о модульном тестировании с примерами JavaScript) и это означает, что мы теряем над ними контроль.
Как правило, мы должны использовать в наших методах 3 или менее параметров. Я думаю, что иногда это было бы сложно, но если нам нужно добавить больше параметров в наши функции, это может быть по двум причинам:
- Нам нужно разделить метод на разные функции. Возможно, наши функции не соответствуют принципу единая ответственность.
- Мы должны инкапсулировать наши параметры, используя структуру в виде массива, объекта, класса и т. д.
Позвольте мне привести вам пример, в котором, чтобы написать более чистый код, мы должны инкапсулировать наши параметры в новый объект. Я рекомендую вам посмотреть пример и узнать, как улучшилась читабельность.
Пример JavaScript
Если вы хотите узнать больше о том, как работает JavaScript, не забудьте прочитать эти статьи:
3. Избегайте магических констант
Это урок, который я прочитал в книге, но который я понял, когда начал свою работу в качестве Backend-разработчика.
Что такое магическая константа? Магическая константа может быть определена как число, которое внезапно появляется в коде. Например, если мы напишем что-то вроде…
isLegalAge = user.age > 18;
18 — магическая константа.
В этом случае легко понять, почему в коде стоит 18. Но посмотрите другой пример:
if (studentNumber > 7) {
// Statements
}
Что такое 7? Почему вместо 7 можно поставить 10?
Это прекрасный пример магической константы и почему использовать ее в наших проектах — плохая идея.
Когда мы используем его постоянно, как в приведенных выше примерах, мы снижаем читабельность и поддерживаемость нашего кода. Пока мы программируем, мы прекрасно знаем, что делаем и зачем. Однако со временем мы не поймем, почему поставили в этом коде цифру 7.
По этой причине предпочтительнее использовать константу (еще одна хорошая практика — выносить константы наружу, чтобы повторно использовать их в нашем коде) с правильным названием и значением. сильный>. Кроме того, использование константы для этого позволяет нам использовать ее во многих местах кода.
Давайте посмотрим, как можно изменить приведенные выше коды, избегая магических констант.
Пример JavaScript
Теперь, с первого взгляда, мы можем прекрасно понять, что если количество учеников превышает максимальное количество учеников в классе, что-то произойдет. И мы можем изменить это число, когда захотим.
Последние мысли
Даже если вы только начинаете заниматься разработкой программного обеспечения или в настоящее время зарабатываете этим деньги, вы хотите писать качественный код. Вы хотите быть разработчиком, способным писать читабельный, понятный, масштабируемый и удобный в сопровождении код. По этой причине вы должны знать, как писать чистый код.
Чистый код – это очень обширная книга, в которой вы найдете множество подробностей и другие рекомендации. Тем не менее, я поделился с вами тремя привычками, которые, по моему мнению, могут улучшить ваш код как минимум на 80%, приложив 20% усилий. (по правилу Парето).
Я надеюсь, что вы найдете эти советы полезными и что они помогут вам так же, как они помогли мне стать лучше как разработчику.
Вы читали «Чистый код»? Знаете ли вы еще одну минимальную практику, которая значительно улучшает качество вашего кода?
Выводы 👋
Спасибо! Большое спасибо за прочтение статьи. Если вы хотите узнать больше о технологиях и разработках, не забудьте подписаться на меня. Мне бы очень хотелось узнать ваше мнение об этом, так что, чувак, не пишите это в комментариях, я вас прочитаю.
Если эта статья помогла вам вспомнить, вы можете похлопать ей и поделиться ею со своими товарищами.
Об авторе🤓
Привет! Рад встрече! Я Хесус Лагарес. В настоящее время я работаю разработчиком программного обеспечения для серверной части и получаю степень по компьютерным наукам в Университете Кадиса.
Две мои страсти — технологии и общение, поэтому я использую любую возможность, чтобы поговорить или написать о технологиях. Я люблю превращать сложные понятия в простые, понятные каждому.
Хотите подключиться? 📲
📸 Инстаграм | 💼LinkedIn |📹 Youtube |🐦Twitter
Спасибо! ❣️
Дополнительные материалы на PlainEnglish.io. Подпишитесь на нашу бесплатную еженедельную рассылку новостей. Подпишитесь на нас в Twitter, LinkedIn, YouTube и Discord . Заинтересованы в хакинге роста? Ознакомьтесь с разделом Схема.
