Картинка выше классная, но к этой статье, к сожалению, не имеет никакого отношения. Идем дальше…

Хорошо. Я понимаю. Вы спешите. Однако вы не должны представлять это в коде. Требуется чистый код, вопреки тому, что думает большинство людей. Например, взгляните на следующие фрагменты кода, которые возвращают удобочитаемую дату из объекта Date:

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

1. Пробелы

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

Видите, как я ставлю пробел перед и после равенства, тернарных операторов, плюсов и минусов? Это выглядит намного лучше, чем если бы вы этого не сделали:

2. Ограничение длины строки в 80 символов

Это то, что обычно пропускают. Например, см. второй фрагмент. У меня есть строки, которые превышают отметку в 150 символов! Это затрудняет понимание вашего кода и сбивает с толку любых читателей (это двоеточие является частью тернарного оператора или оно находится в строке?). Однако вы можете разделить свой код после любых операторов, и я советую вам сделать это или даже повторить ваш код, если возможно упростить его! Хотя я говорю, что это предел в 80 символов, некоторые программисты расширяют его до 100 или даже 120 символов. Все в порядке, пока вы остаетесь последовательным.

3. Структура файла

Под файловой структурой я имею в виду, где все находится. Трудно что-то найти, если у вас есть метод, затем переменная, цикл, вызов метода, определение другого метода… Вы меня поняли. Обычно у меня сначала файловая структура импорта, затем переменные, потом методы, потом классы.

4. ДжСДок

Помните, что при использовании JSDoc используйте его только в соответствующих местах. Например, бесполезно иметь метод с именем «isEvenNumber» с числовым параметром, а затем писать для него JSDoc. Я имею в виду, уже легко понять, что делает метод. Напротив, вам, возможно, придется объяснить более продвинутые методы или классы, такие как класс с именем «InputHandler», где будет много продвинутых методов, которые связывают ключи, добавляют слушателей и т. д.

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

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

Если вам нужна дополнительная помощь, обратитесь к Руководству по стилю Google. Это все! Увидимся позже!