Как сделать многострочный комментарий в js

Обновлено: 04.07.2024

Как говорится, нет правила без правил; хотя код набирается и передается компилятору для интерпретации и выполнения, до тех пор, пока нет грамматических ошибок и ошибок форматирования, независимо от того, насколько античеловечен набор, нет проблем, но код - это еще одно широкое применение, помимо выполнения Просто прочтите его, просмотрите свой прошлый код, разберитесь в исходном коде других людей и т. Д., Так что существует стилизация кода, которая может улучшить внешний вид, но при этом его легко читать.

Конечно, помимо самого кода, дополнительное чтение может быть связано с комментариями к коду. Сами комментарии не будут компилироваться и выполняться компилятором, и их роль заключается в том, чтобы оставить некоторую информацию, чтобы облегчить лучшее понимание самого кода; поэтому прокомментированные Стандартизация - это тоже вопрос, над которым стоит подумать; и следующий вопрос будет представленJSDoc Это такой инструмент;

JSDoc

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

использовать

Пользоваться инструментом очень просто, сначала установите его:

Во-вторых, предположим, что в doc.js Напишите в файл следующий код:

Затем выполните следующую команду в текущем каталоге:

Наконец, файл с именем out Содержимое текущего каталога станет следующим:

Посетите это через браузер out Связанные веб-страницы в каталоге будут отображать контент, подобный следующим страницам;

jsdoc-home.jpg

Укажите страницу функции:

jsdoc-func.jpg


Шаблон стиля веб-страницы также можно заменить, просто измените его в соответствии с параметрами командной строки, я не буду рассматривать его здесь, давайте узнаем о формате его комментариев;

Формат комментария

Комментарий

JSDoc использует следующий формат символов комментария для обертывания тегов, которые будут добавлены на уровне блока:

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

@description

Также можно написать @desc , Чтобы описать подробную информацию о текущем объекте аннотации;

Комментарий записывается в начале файла, чтобы описать соответствующую информацию о текущем файле; например:

@author

Опишите соответствующую информацию об авторе текущего файла или кода;

@copyright

Опишите информацию об авторских правах текущего файла

@license

Опишите информацию, относящуюся к текущей лицензии на файл;

@version

Опишите номер версии текущего проекта;

@since

Опишите, в какой версии была введена функция;

Опишите, что делать дальше;

@function

против @func , @method То же самое означает описание функции;

Опишите тип переменной;

@param

против @arg , @argument То же самое означает описание информации о параметрах функции;

@typedef

Используется для описания типов пользовательских переменных;

@callback

Опишите информацию о параметрах указанной функции как функцию обратного вызова;

@returns

Или напишите @return , Информация, описывающая возвращаемое значение функции;

@example

Опишите пример использования указанного кода;

@class

Опишите class учебный класс;

@namespace

Опишите пространство имен;

@member

Описать член текущего класса;

@memberof

Опишите класс, к которому принадлежит член;

Техническая статья push Мобильный телефон, совместное использование компьютерных программ

Интеллектуальная рекомендация

Как Python получает информацию о версии

Mysql соединение ненормально


Создание среды автоматизации Android в среде Windows (Framework для Appium)

Краткие шаги для сборки Android следующие: 1. Установите JDK, настройте переменную среды JDK. Обратите внимание, что компьютер - 32 бита или 64 бита, и он должен быть связан с. 2. Установите Eclipes и.

Android SQLite данные локального кэша

1. В Android локальное хранилище данных делится на хранилище данных SQLite, хранилище данных Sharedprferences, хранилище файлов, ContentProvider и одно для сети (сеть). 1. Главным образом объясните хр.


Междоменная обработка jsonp в jQuery, без разрешения-контроля доступа, неожиданный токен

введение Ajax не может успешно получать данные между доменами и должен обрабатываться jsonp Ошибка следующая 1. Перейдите на jsonp На данный момент этого недостаточно. По-прежнему не удается получить .

Сегодня мы публикуем перевод следующей части руководства по JavaScript. Здесь мы поговорим о стиле кода и о лексической структуре программ.




Стиль программирования

Существует немало руководств по стилю. Вот 2 из них, которыми в мире JavaScript пользуются чаще всего:

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

Стиль, используемый в этом руководстве

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

Вот список правил, о которых идёт речь.

  • Именование сущностей. Имена функций, переменных и методов объектов всегда начинаются со строчной буквы, имена, состоящие из нескольких слов, записываются с использованием верблюжьего стиля (выглядят такие имена как camelCase ). С прописной буквы начинаются только имена функций-конструкторов и классов. Если вы используете некий фреймворк, предъявляющий особые требования к именованию сущностей — пользуйтесь предписываемыми им правилами. Имена файлов должны состоять из строчных букв, отдельные слова в именах разделяются тире ( - ).
  • Правила построения и форматирования выражений.


for. Для организации циклов используется либо стандартная конструкция for , пример которой приведён ниже, либо цикл for of . Циклов for in следует избегать — за исключением тех случаев, когда они используются вместе с конструкцией .hasOwnProperty() . Вот схема цикла for :


while. Вот схематичный пример цикла while :


do. Вот структура цикла do :


switch. Ниже показана схема условного оператора switch :


try. Вот несколько вариантов оформления конструкции try-catch . Первый пример показывает эту конструкцию без блока finally , второй — с таким блоком.

  • Пробелы. Пробелы следует использовать разумно, то есть так, чтобы они способствовали улучшению читабельности кода. Так, пробелы ставят после ключевых слов, за которыми следует открывающая круглая скобка, ими обрамляют операторы, применяемые к двум операндам ( + , - , / , * , && и другие). Пробелы используют внутри цикла for , после каждой точки с запятой, для отделения друг от друга частей заголовка цикла. Пробел ставится после запятой.
  • Пустые строки. Пустыми строками выделяют блоки кода, содержащие логически связанные друг с другом операции.
  • Кавычки. При работе со строками используются одинарные кавычки ( ' ), а не двойные ( " ). Двойные кавычки обычно встречаются в HTML-атрибутах, поэтому использование одинарных кавычек помогает избежать проблем при работе с HTML-строками. Если со строками нужно выполнять некие операции, подразумевающие, например, их конкатенацию, следует пользоваться шаблонными литералами, которые оформляют с помощью обратных кавычек ( ` ).

Лексическая структура JavaScript-кода

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

▍Unicode

JavaScript-код представляется с использованием кодировки Unicode. Это, в частности, означает, что в коде, в качестве имён переменных, можно использовать, скажем, символы смайликов. Делать так, конечно же, не рекомендуется. Важно здесь то, что имена идентификаторов, с учётом некоторых правил, могут быть записаны на любом языке, например — на японском или на китайском.

▍Точка с запятой

Синтаксис JavaScript похож на синтаксис C. Вы можете встретить множество проектов, в которых, в конце каждой строки, находится точка с запятой. Однако точки с запятой в конце строк в JavaScript необязательны. В подавляющем большинстве случаев без точки с запятой можно обойтись. Разработчики, которые, до JS, пользовались языками, в которых точка с запятой не применяется, стремятся избегать их и в JavaScript.


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

▍Пробелы

JavaScript не обращает внимания на пробелы. Конечно, в определённых ситуациях отсутствие пробела приведёт к ошибке (равно как и неуместный пробел там, где его быть не должно), но очень часто между отсутствием пробела в некоем месте программы и наличием одного или нескольких пробелов нет никакой разницы. Похожее утверждение справедливо не только для пробелов, но и для знаков перевода строки, и для знаков табуляции. Особенно хорошо это заметно, например, на минифицированном коде. Взгляните, например, во что превращается код, обработанный с помощью Closure Compiler.

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

▍Чувствительность к регистру

JavaScript — регистрозависимый язык. Это означает, что он различает, например, имена переменных something и Something . То же самое касается любых идентификаторов.

▍Комментарии

В JavaScript можно использовать два типа комментариев. Первый тип — однострочные комментарии:


Они, как следует из названия, располагаются в одной строке. Комментарием считается всё, что идёт за символами // .

Второй тип — многострочные комментарии:


Тут комментарием считается всё, что находится между комбинацией символов /* и */ .

▍Литералы и идентификаторы

Литералом называется некое значение, записанное в исходном коде программы. Например — это может быть строка, число, логическое значение, или более сложная структура — объектный литерал (позволяет создавать объекты, оформляется фигурными скобками) или литерал массива (позволяет создавать массивы, оформляется с помощью квадратных скобок). Вот несколько примеров:


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

Идентификатором называется последовательность символов, которая может быть использована для идентификации переменной, функции, объекта. Она может начинаться с буквы, знака доллара ( $ ) или со знака подчёркивания ( _ ), может содержать цифры, и, если нужно, символы Unicode вроде смайликов (хотя, как уже было сказано, лучше так не делать). Вот несколько примеров идентификаторов:


Знак доллара обычно используется при создании идентификаторов, хранящих ссылки на элементы DOM.

▍Зарезервированные слова

Ниже приведён список слов, которые зарезервированы языком. Использовать их в качестве идентификаторов нельзя.

  • break
  • do
  • instanceof
  • typeof
  • case
  • else
  • new
  • var
  • catch
  • finally
  • return
  • void
  • continue
  • for
  • switch
  • while
  • debugger
  • function
  • this
  • with
  • default
  • if
  • throw
  • delete
  • in
  • try
  • class
  • enum
  • extends
  • super
  • const
  • export
  • import
  • implements
  • let
  • private
  • public
  • interface
  • package
  • protected
  • static
  • yield

Итоги

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

В большинстве редакторов строку кода можно закомментировать, нажав комбинацию клавиш Ctrl+/ для однострочного комментария и что-то вроде Ctrl+Shift+/ – для многострочных комментариев (выделите кусок кода и нажмите комбинацию клавиш).

Как комментировать в Brackets?

  1. F2 — переименовать символ (функцию, переменную и т.
  2. Ctrl + Shift + O — перейти к символу;
  3. Ctrl + K Z — перейти в режим Дзен, в котором вас не отвлекают лишние детали;
  4. Ctrl + / — закомментировать/раскомментировать строку;
  5. Shift + Alt + A — закомментировать/раскомментировать блок кода;

Что такое комментарий в HTML?

HTML комментарии призваны улучшить читабельность кода. В комментариях обычно указывается объяснение участка кода, что упрощает процесс редактирования HTML страницы в дальнейшем. Комментарии в HTML не отображаются на странице в браузере пользователю, однако их можно увидеть в исходном коде веб-страницы (см.

Как в Python сделать комментировать?

Какие символы можно нельзя использовать при именовании переменных в Python?

имя переменной может состоять только из букв, цифр и знака подчёркивания; имя не может начинаться с цифры; имя не может содержать специальных символов @, $, %.

Как закомментировать сразу несколько строк Python?

Так, например, чтобы закомментировать несколько строк Python кода, в PyCharm, следует их выделить и нажать комбинацию клавиш +.

Как в PyCharm закомментировать несколько строк?

В JetBrains PyCharm на Mac используйте Command + / для комментирования/раскомментирования выбранного блока кода. На Windows используйте CTRL + / .

Как закомментировать несколько строк в Java?

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

  1. Ctrl + 1 — быстрое исправление;
  2. Ctrl + Alt + R — переименовать;
  3. Ctrl + / — закомментировать/раскомментировать строку;

Как закомментировать несколько строк в VS Code?

Для того, чтобы закомментировать (или раскомментировать) строку, мы можем использовать сочетание Ctrl+/ — Toggle Line Comment. Так же, как и в предыдущем случае, для того, чтобы закомментировать несколько строк одновременно, нам потребуется их выделить.

Как выделить несколько строк в VS Code?

Пресса Crtl + Shift + Alt + Arrow up/down чтобы выбрать несколько строк в Visual Studio Code. Обратите внимание, что выбранные строки будут находиться в одном столбце (если это возможно). Вы также можете отметить некоторые линии, а затем выполнить эту комбинацию, и у вас будут включены все выбранные линии.

Как делать комментарии в VS Code?

Обычно чтобы добавить комментарий, нужно перейти в начало строки и дописать туда два слеша. Это медленно. Быстрее нажать в любом месте строки Ctrl + /, и строка закомментируется, если она ещё не. А если уже да, то комментарий исчезнет.

Как раскомментировать код?

Чтобы быстро закомментировать или раскомментировать строку кода в HTML или CSS редакторе, можете использовать сочетание клавиш ctrl + / или cmd + / .

Как закомментировать Webstorm?

2) Ctrl + / / CMD + / (Comment/uncomment with line comment) — закомментировать участок кода с помощью двойного слеша. 4) Ctrl + Shift + Backspace / CMD + Shift + Backspace (Last Edition Location) — вернуться к предыдущему месту редактирования, работает так же, даже если до этого вы редактировали другой файл.

Как закомментировать код в C++?

Закомментировать код // std::cout Как это раскомментировать строку?

Как комментировать в Notepad ++?

Также CTRL + K хорошо работает в Notepad ++, чтобы комментировать. Если у вас были комментарии в длинном блоке, который вы комментируете, CTRL + Q раскомментирует ваши фактические комментарии, где CTRL + K просто добавьте еще один уровень // впереди. CTRL + SHIFT + K удаляет однострочный комментарий из выделения.

Как закомментировать код в Sublime Text 3?

  1. Свернуть текущий блок Ctrl+Shift+[ Ctrl+Cmd+[
  2. Развернуть текущий блок Ctrl+Shift+] Ctrl+Cmd+]
  3. Закомментировать строку Ctrl+/ Cmd+/
  4. Закомментировать блок кода (курсор в блоке) Ctrl+Shift+/ —

Как в Sublime Text разделить экран?

Mac: CMD+ALT+Shift+1/2/3 Вместо того чтобы постоянно переключаться между файлами, Sublime дает возможноcть разделять рабочую область вертикально или горизонтально на несколько частей. Очень юзабельно. А используя Num1 в приведенных выше сочетаниях, возвращаем единый экран.

Как открыть боковую панель в Sublime Text 3?

Чтобы включить боковую панель, вы должны сделать вид — > боковая панель — > показать открытые файлы. Вы получите дерево открытых файлов (вкладок) и структуру папок на боковой панели. Используйте Ctrl + 0 , чтобы переключить фокус на боковую панель. Я могу изменить размер шрифта боковой панели Sublime Text 2.

Как сделать замену в Sublime?

Таким образом, чтобы осуществить в данной программе поиск и замену вам надо:

Как искать в Sublime?

  1. Как в любом текстовом редакторе, в Sublime Text 2 есть поиск.
  2. Все доступные варианты поиска можно увидеть в меню Find ….
  3. Наряду с обычным поиском, существует еще дополнительный Find Incremental Find, который вызывается сочетанием клавиш ctrli.

Как заменить текст во всех файлах в папке?

Как писать сразу в нескольких строках Sublime?

Единственный способ сделать многострочный курсор в Sublime text 3-Это Ctrl+Shift+RC+Drag.

Как поставить несколько курсоров?

Для многострочного выбора Ctrl+Alt+Down / ⌘+Alt+Shift+Down расширит ваш выбор или положение курсора до следующей строки. Ctrl+Right / ⌘+Right будет двигаться к концу каждой строки, независимо от того, как долго. Чтобы избежать многострочного выбора, нажмите Esc .

Как сделать много курсоров?

Для многострочного выделения Ctrl+Alt+Down / ⌘+Alt+Shift+Down расширит ваш выбор или позицию курсора до следующей строки.

Как дублировать строку в Sublime?

Хоткей Описание
ctrlshiftup Переместить выделенные строки вверх.
ctrlshiftdown Переместить выделенные строки вниз.
ctrlshiftd Дублировать строку.
ctrlshiftk Удалить строку.

Как дублировать строку?

  1. Windows, Ubuntu — Ctrl + Shift + d.
  2. Mac — Command + Shift +d.

Как открыть командную строку в Sublime Text 3?

Перезапускаем Sublime Text, нажимаем ( в OS X), чтобы открыть командную строку (это не то же самое, что консоль!), пишем install и нажимаем Enter. Перед нами — каталог с плагинами. Теперь достаточно набрать название нужного и снова нажать Enter.

Как выделить строку горячие клавиши?

Другие способы выделения текста

  1. Чтобы выделить одно слово, дважды щелкните его.
  2. Чтобы выделить строку текста, поместите курсор в ее начало и нажмите клавиши SHIFT+СТРЕЛКА ВНИЗ.
  3. Чтобы выделить абзац, поместите курсор в его начало и нажмите клавиши CTRL+SHIFT+СТРЕЛКА ВНИЗ.

Как выделить отдельные части текста?

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

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

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

Простые и понятные имена переменных, функций и классов.

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

Это означает, что не должно быть имён типа b , также как и не должно быть излишне громоздкое и перенасыщенное посторонними словами вроде soVeryUselessLongBirthdayVariable . Было бы уместно назвать его просто birthday .

Кроме этого, лучше избегать комбинирования имени с функциональностью в названии переменной. Например, если мы хотим написать функцию по проверке достижения пользователем совершеннолетия, мы должны назвать её чем-то вроде isAdult() , а не isOverEighteen() .
Это также имеет больше смысла, так как не в каждом месте возраст 18 лет является возрастом совершеннолетия.

Мы также можем рассмотреть венгерскую нотацию для именования переменных и функций. Нотация объединяет в себе тип возврата, и имя в одно название. Поскольку JavaScript-функция не имеет определённого типа возврата, мы можем добавить префикс типа для функции.
Например, если переменная возвращает булево значение с помощью функции isAdult() , мы можем написать bIAdult() с указанием b , что она является булевым значением.

Также рекомендуется хранить имена на английском языке, так как это сохраняет консистентность стиля в соответствии с остальным кодом. Все зарезервированные слова, такие как function и new - всё на английском языке, так что всё остальное должно быть на английском.
Английский также более интернациональный язык, так что вероятность больше, что разработчики знают английский язык, и смогут прочитать ваш код.

Классы - это функции, которые создают другие объекты, поэтому их названия должны отражать это. Например, если у нас есть класс, который создаёт объект человека, то он должны быть названы как Person .
Имена классов должны быть в верхнем регистре и указывать, какой именно объект мы из него создаём.

Избегайте частого использования глобальных переменных и функций.

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

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

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

Например, с var , если мы пишем следующий код:

Выполнив этот пример, вызвав console.log, мы увидим результат 1. Это всё из-за того, что объявление переменной через var применяется к глобальной области видимости.

В другом же случае, если мы используем let вместо var :

В результате мы получаем ошибку 'Uncaught ReferenceError: x is not defined' .
Как мы видим, мы не можем обращаться к переменным, которые доступны только в ограниченной области видимости (в данном случае, области видимости функции).

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

Например, мы можем написать:

И тут мы также мы получим ошибку 'Uncaught ReferenceError: x is not defined' . Функция, которая запускается сразу же после объявления, как показано выше, называется IIFE (Immediately Invoked Function Expression) "Функция немедленного вызова".
Если мы хотим вернуть что-то из этой функции другому коду, который у нас есть выше, мы можем просто вернуть данные следующим образом:

Мы вернули объект со свойством bar и присвоили его переменной foo . И, в результате, мы должны получить 2 из вывода console.log .

Следуйте строгому стиль программирования.

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

Есть также такие инструменты, как Prettier , для последовательного форматирования кода посредством стиля кода нашего приложения.

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

Комментарий при необходимости

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

Простая функция, которая состоит из нескольких строк, наверное, не нуждается в больших пояснениях.

Если мы пишем комментарии, то следует использовать многострочные комментарии /* */ вместо однострочных // , так как они более универсальны.

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

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

Вышеуказанный код раскомментирован.

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

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

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

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

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

И вот они все и есть, лучшие JavaScript практики по комментированию, именованию и стилю написания кода.

Читайте также: