Комментарии

Что такое комментарии?

В JavaScript есть несколько способов указать комментарии в коде

Порой при написании кода вам необходимо будет снабдить его пояснениями, предназначенными только для людей , а не для компьютера. Возможно, это будет некое послание к себе из прошлого (к Будущему Мне!) по поводу той или иной вещи в программном коде. А может, это будет просто указание, что запустить нужно лишь такую-то часть кода, а прочее надлежит опустить. Словом, в любом подобном случае вам необходимо будет прибегнуть к помощи комментариев. Комментарии используются для добавления ➕ подсказок, заметок , предложений или предупреждений. Они могут упростить чтение и понимание 💡 кода. Также они могут быть использованы для предотвращения выполнения кода (этот приём практикуется при отладке кода).

В JavaScript есть несколько способов указать комментарии в коде.

Видео

Однострочный комментарий

Первый 1️⃣ способ // комментарий в этом случае весь текст в строке после двойного слэша будет комментарием . Когда интерпретатор видит два 2️⃣ слэша подряд //, он сразу понимает, что всё, что идёт далее до конца строки, можно смело проигнорировать. Пока не обращайте внимание на синтаксис кода, с ним мы детально познакомимся чуть позже.

Интерактивный редактор

function learnJavaScript() { // Это комментарий в строке var hello = 'Hello world!!!' return hello }

function learnJavaScript() {
  // Это комментарий в строке
  var hello = 'Hello world!!!'

  return hello
}

Результат

Loading...

Многострочный комментарий

Второй 2️⃣ способ - это /* */, такой способ более гибок, чем первый 1️⃣ . Как только интерпретатор видит /*, он думает: "Ага, значит, пока я не увижу */, то могу ни на что здесь не обращать никакого внимания!" Например, вы можете использовать его в одной 1️⃣ строке :

Интерактивный редактор

function learnJavaScript() { /* Это однострочный комментарий */ var hello = 'Hello world!!!' return hello }

function learnJavaScript() {
  /* Это однострочный комментарий */
  var hello = 'Hello world!!!'

  return hello
}

Результат

Loading...

Либо вы можете сделать многострочный комментарий , как показано здесь :

Интерактивный редактор

function learnJavaScript() { /*Этот комментарий располагается на нескольких линиях. Обратите внимание, что вам не нужно обрывать комментарий, пока вы его не закончите*/ var hello = 'Hello world!!!' /* Напишите здесь свой комментарий */ return hello }

function learnJavaScript() {
  /*Этот комментарий располагается на нескольких линиях. 
     Обратите внимание, что вам не нужно обрывать комментарий, пока вы его не закончите*/
  var hello = 'Hello world!!!'
  /* Напишите здесь свой комментарий */
  return hello
}

Результат

Loading...

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

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

Интерактивный редактор

function learnJavaScript() { var x = '' var hello = 'Hello ' + x /* вставьте значение x */ + '!' return hello }

function learnJavaScript() {
  var x = ''
  var hello = 'Hello ' + x /* вставьте значение x */ + '!'

  return hello
}

Результат

Loading...

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

Это не только облегчает понимание нашего кода, но и помогает улучшить общий дизайн программы!

Этот тип кода часто называют самодокументированием.

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

С комментированием кода все и прозвучал звонок на перемену .

React Native

Пример того, где еще мы можем использовать комментарии в реальном React Native проекте. Вдруг нам нужно будет скрыть некоторый код. Для этого нам нужно обернуть его в комментарии. Обратите внимание на то, что блок с комментариями работал его необходимо завернуть в фигурные скобки, иначе библиотека React не поймет, что это JavaScript выражение - это специфика синтаксиса JSX который мы изучим по курсу позже. Попробуйте раскомментировать код и после закомментировать его обратно.

Проблемы?

Пишите в Discord или телеграмм чат, а также подписывайтесь на наши новости

Вопросы:

Для кого предназначены комментарии?

1. Человек
2. Консоль
3. Интерпретатор JavaScript

Для чего используются комментарии?

1. Добавление подсказок, заметок, предложений
2. Для выполнения запросов
3. Для предотвращения выполнения кода

Какого из способов указания комментария в коде JavaScript не существует?

1. (' ')
2. //
3. /* */

Как отключить любое количество строк кода?

1. Написать комментарий посреди кода
2. Обернуть код в комментарий
3. Использовать команду console.log

Интерпретатор JavaScript ____ любые найденные комментарии.

1. Выполняет
2. Игнорирует
3. Компилирует

Какой символ обозначает однострочный комментарий?

1. //
2. \\
3. ||

Какие символы необходимо ввести, чтобы начать комментарий блока?

1. /*
2. *\\
3. //

Какой термин относится к коду, который имеет полезные имена переменных и описательных имен функций, чтобы разработчику было легко понять цель кода, когда он его читает (без особой необходимости в пояснительных комментариях)?

1. Самодокументирование
2. Документирование
3. Рукопись

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

Ссылки:

1. MDN web docs
2. Код для подростков: прекрасное руководство по программированию для начинающих, том 1: Javascript - Jeremy Moritz
3. JavaScript.ru

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Dmitriy Vasilev

Resoner2005 🐛 🎨 🖋