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

Любой разработчик, который не согласен с такими простыми вещами, как соглашения об именах или документирование и определение функций, покупает себе большую головную боль, особенно если они работают как часть команды (т.е. что-нибудь ›1). Представьте себе любую команду разработчиков, каждый из которых пишет код в собственном стиле; Это выглядело бы так, как будто орки пытаются съесть последний бифштекс в Средиземье.

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

К счастью, у нас есть секретное оружие - стандарты кодирования.

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

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

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

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

В мире Javascript, откуда я родом, Руководство по стилю Airbnb является одним из самых известных стандартов кода, на котором команды разработчиков по всему миру основывают свои рекомендации, и он чертовски сильно превосходит наши ожидания, поскольку команда здесь, в Leaf Grow.

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

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

Eslint довольно легко настроить, так как вы можете добавить руководство по стилю Airbnb в качестве стандарта по умолчанию. Вы также можете создать свои собственные правила и / или переписать любое заранее определенное правило Airbnb.

В конце концов, самое главное, чтобы исходный код был чистым, непротиворечивым и простым в обслуживании.

Мы также используем Prettier; этот инструмент автоматически форматирует наш код, поэтому мы не тратим на это время. Он выполняет свою работу довольно быстро - его почти не видно, если он работает вместе с вашим редактором.

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

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

Короче говоря, можно сказать, что преимущества кодирования, основанного на стандарте стиля кода, заключаются в следующем:

  • Ваш код легче читать.
  • Ваш код легче понять.
  • Ваш код легче поддерживать.

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

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

Pura Vida!