вступление

Если вы хотите стать действительно хорошим инженером-программистом, недостаточно просто изучить некоторые базовые принципы языка. Недостаточно даже знать язык на достаточно продвинутом уровне. Чтобы стать по-настоящему порядочным разработчиком, вам необходимо знать такие вещи, как: Чистый код, Лучшие практики, Дизайн приложений, Шаблоны и т. д., которые напрямую не связаны с конкретным языком программирования.

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

Какая лучшая практика?

Лучшие практики - это практически все, что сделает ваш код лучше, надежнее, читаемым, хорошо структурированным, масштабируемым и легким для понимания. Но это очень расплывчатое описание, не правда ли? Итак, позвольте мне дать вам небольшое представление о лучших практиках, используя в качестве примера переменные JavaScript.

Соглашение об именовании

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

Это будет определять, насколько это просто:

  • Чтобы понять ваш код
  • Чтобы перемещаться по нему
  • Чтобы поддерживать это

Итак, что мы можем сделать, чтобы действительно улучшить именование?

Разделение случаев использования

Есть несколько известных разделителей регистра

Это основные регистры-разделители. Как видите, основная цель их использования - разделить слова в именах переменных. Таким образом, ваш код будет намного легче читать.

Давайте сделаем быстрое сравнение:

Итак, выгода очевидна, но какой из них выбрать? Дам несколько советов:

  1. Если в вашей кодовой базе уже используется одно из соглашений, просто следуйте ему - сохраняйте последовательность, даже если это вам не нравится.
  2. Если кодовая база беспорядочная или не имеет каких-либо соглашений, выберите одну и следуйте ей. В этом случае вам придется защищать свой выбор и следить за тем, чтобы другие тоже следовали ему.
  3. Если вы работаете с JavaScript, согласованным стандартом является использование camelCase для переменных, свойств объекта, функций и методов объекта.
  4. PascalCase часто используется для имен классов.

Например:

5. SNAKE_UPPER_CASE часто используется для обозначения констант уровня приложения. Обычно содержит конфигурации, необходимые для работы вашего приложения. Например, он может содержать некоторые строки подключения API, токены, постоянное значение для настроек приложения, например количество подключений и т. Д.

Значимые имена

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

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

Вы можете подумать, что короткая переменная лучше, потому что вы сохраняете кусочки в своем коде и т. Д. Но в основном это неверно, особенно если мы говорим о JavaScript. Ваш код в любом случае будет минимизирован и транспонирован для производства. Таким образом, все ваши хорошо написанные имена в конечном итоге будут точно a, b, c в вашем браузере. Но для инженеров, пока вы работаете с кодом, старайтесь, чтобы он был как можно более описательным. Несколько примеров плохого и хорошего:

Так что не бойтесь сделать имя немного крупнее, но более информативным. И не ленитесь тоже. Людям нравится сокращать имена, чтобы сэкономить миллисекунды времени, но они не понимают, что они и другие будут тратить минуты или, может быть, даже часы, чтобы за три месяца выяснить, что имелось в виду под uau.

Постарайтесь также не чрезмерно объяснять свои переменные, поэтому, например, что-то вроде userObject или basketListArray будет немного излишним. Люди должны иметь IntelliSense в своих IDE, и если вы правильно назовете переменные, будет очевидно, какой тип контента там будет.

Исключения из правил

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

Надеюсь, вы уловили идею относительно большей части вашего кода 💡.

Декларация

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

Изменчивость и область действия

Хорошая практика программирования состоит в том, чтобы создавать ваше приложение со всем закрытым, ограниченным и защищенным в максимально возможной степени. Это нужно для предотвращения потенциальных ошибок. И чтобы убедиться, что ваш код будет использоваться правильно.

Таким образом, в JavaScript не так много способов защитить конфиденциальность кода. Но что вы можете сделать, так это использовать const и let для предотвращения мутаций и контроля объема ваших данных.

Поэтому хорошей практикой было бы использовать ключевое слово const для каждого объявления переменной и изменять его только тогда, когда это действительно необходимо. И используйте let вместо var, если вам нужны изменяемые данные, но вы по-прежнему будете контролировать область видимости. Таким образом вы уменьшите вероятность появления ошибок в вашем коде.

Заворачивать

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

дальнейшее чтение

Если вы действительно заинтересованы в том, чтобы ваш код был чистым, я предлагаю вам взглянуть на эту книгу - «Чистый код: руководство по Agile Software Craftsmanship» Роберта К. Мартина.

Примечание от Plain English

Вы знали, что у нас четыре публикации? Проявите немного любви, предложив им следующие слова: JavaScript на простом английском, AI на простом английском, UX на простом английском , Python на простом английском - спасибо и продолжайте учиться!

Кроме того, мы всегда заинтересованы в продвижении хорошего контента. Если у вас есть статья, которую вы хотели бы отправить в какую-либо из наших публикаций, отправьте электронное письмо на адрес [email protected] с вашим именем пользователя Medium и тем, о чем вы хотите написать, и мы вернуться к вам!