Вы когда-нибудь слышали, что ваш код не читается или непонятен другим, и вы не могли догадаться, почему? Если да, то эта статья для вас.
Одна из проблем, с которыми вы столкнетесь при написании кода на любом языке программирования, - это написание читаемого кода. Это означает, что вы должны написать код, который вы сможете понять в будущем через год. Кроме того, код должен быть разборчивым и понятным для других членов команды.
Итак, что мы подразумеваем под чистым кодом:
Когда мы пишем чистый код, мы должны позаботиться об отступах, запятых, именах переменных, именах функций, комментариях и всем внешнем виде нашего кода. Не существует единого правила, которому нужно следовать. Вот наиболее распространенные стандарты:
Вы можете выбрать один из них при написании кода. Как команда, вы можете согласовать свои стандарты написания кода. Здесь мы опишем самые общие правила написания читаемого кода.
Давайте копать глубже:
- Именование переменных:
Название переменных должно описывать то, что они представляют. Например, не используйте такое имя переменной, как A, B. Используйте осмысленные имена переменных. Кроме того, переменные, состоящие из нескольких частей, должны соответствовать правилу camelCase rule. И когда мы определяем постоянную переменную, мы пишем все буквы с большой буквы.
вот пример хорошего именования:
2. Пространства:
Пробелы слишком сильно повлияют на внешний вид вашего кода. Вот почему вы всегда должны уделять им свое внимание. Вот несколько полезных советов:
2.1 Фигурные скобки:
- Открывающая скобка фигурных скобок должна находиться на той же строке, что и вызывающие ключевые слова, например:
if, for, while, etc. - Между круглыми скобками и открывающей скобкой должен быть пробел.
- Код блока должен быть в следующей строке на расстоянии табуляции от начала ключевого слова.
- Всегда помещайте закрывающую скобку в другую строку с выравниванием по началу ключевого слова.
2.2 При определении функции: без пробелов между именем функции и скобками, а также без пробелов между скобками и параметрами. Пробелы нужны только в том случае, если у нас несколько параметров, как показано ниже:
2.3 В вашем коде нам нужно добавить пробел между определением переменной и следующей логикой. Всегда при переключении между логиками нам нужен однострочный интервал между ними.
2.4 В условном предложении мы помещаем слово else рядом с закрывающей скобкой условия if и разделяем их пробелом:
2.5 Также предпочтительны пробелы между аргументами и операторами.
3. Функции
При написании имени функции старайтесь использовать описательное имя. чтобы узнать, что делает функция, по ее имени. Еще один момент: постарайтесь, чтобы каждая функция выполняла одно задание. Вся логика и переменные внутри функции должны иметь отступ табуляции (2 пробела) от начала функции, а закрывающая скобка должна иметь тот же отступ, что и имя функции.
4. Длина строки
Ресурсы предложили разбить длинную горизонталь. Обычно длина строки составляет от 80 до 120 символов. Как команда, вы можете прийти к согласию по различным соображениям.
5. Комментарии
Мы используем комментарии, чтобы объяснить, как и почему работает код. Хорошие комментарии помогут легко поддерживать код.
Комментарии могут быть однострочными: начиная с // и многострочными: / *… * /.
В общем, отличный код будет иметь меньше комментариев или вообще не иметь. И вы можете добиться этого, написав описательное именование для функций и переменных. Кроме того, разделяя ваш код на небольшие блоки кода, каждый из них выполняет только одно действие.
Еще хорошо прокомментировать:
- Непонятный фрагмент кода.
- Если есть разные решения конкретной проблемы и вы выбрали одно из них как лучшее, вам следует объяснить, почему вы сделали этот выбор.
- Вы должны прокомментировать использование функции. Для документирования функций существует специальный синтаксис JSDOC.
- Если вы найдете решение для части вашего кода в Интернете, будет полезно добавить к нему URL-адрес в комментариях.
Полезные расширения:
Существует множество расширений, которые выполняют вышеуказанную работу за вас и автоматически форматируют ваш код. Назову некоторые из них:
Заворачивать. Это некоторые моменты, о которых следует позаботиться при написании кода. Так ваш код будет легче читать и понимать.
Для получения дополнительной информации перейдите по этой ссылке:
