Перейти к содержанию

Руководство по стилю

Примечание

Это руководство для Vue.js устарело и требует пересмотра. Если у вас есть вопросы или предложения, пожалуйста, откройте issue.

Это официальное руководство по стилю для кода, специфичного для Vue. Если вы используете Vue в своем проекте, это отличный справочник, который поможет избежать ошибок, «велосипедов» и антипаттернов. Тем не менее, мы не считаем, что какое-либо руководство по стилю идеально подходит для всех команд или проектов, поэтому поощряются разумные отклонения, основанные на прошлом опыте, окружающем технологическом стеке и личных ценностях.

По большей части мы также избегаем предложений о JavaScript или HTML в целом. Нам не важно, используете ли вы точку с запятой или запятую. Нам неважно, используются ли в вашем HTML одинарные или двойные кавычки для значений атрибутов. Однако есть и исключения, когда мы обнаружили, что тот или иной паттерн полезен в контексте Vue.

Наконец, мы разделили правила на четыре категории:

Категории правил

Приоритет А: Важно (предотвращение ошибок)

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

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

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

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

Приоритет D: Используйте с осторожностью

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

Руководство по стилю