Как закоментить в javascript

Как закомментировать код в js

В JavaScript есть два вида комментариев: однострочные и многострочные. Однострочные выглядят следующим образом:

// однострочный комментарий const something = 1; // тоже однострочный коммент 

Синтаксис многострочных комментариев отличается:

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

Комментирование кода в JavaScript — типы и передовые методы

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

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

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

В этой статье мы рассмотрим, как комментировать код JavaScript, какие типы комментариев существуют, а также некоторые передовые практики.

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

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

Давайте посмотрим на пример однострочного комментария в действии:

// Print "Hello World" in the console console.log("Hello World"); 

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

Если однострочный комментарий появляется в конце строки кода, он называется встроенным комментарием.

Обычно они используются для добавления быстрых аннотаций:

let c = a + b; // Assign sum of a, b to c 

Многострочные комментарии и строки документации JavaScript

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

Многострочные комментарии начинаются /* и заканчиваются */ :

/* The following program contains source code for a game called Tic-tac-toe. It is a paper-and-pencil game for two players, X and O, who take turns marking the spaces in a 3×3 grid. The player who succeeds in placing three of their marks in a horizontal, vertical, or diagonal row is the winner */ 

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

Часто можно увидеть и другой тип многострочного комментария:

/** * The following program contains source code for a game called Tic-tac-toe. * It is a paper-and-pencil game for two players, X and O, who take turns marking the * spaces in a 3×3 grid. * The player who succeeds in placing three of their marks in a horizontal, vertical, or * diagonal row is the winner */ 

Часто эти комментарии могут включать информацию о выполняемом коде, такую ​​как параметры функции или даже автора кода:

/** * Function that greets a user * @author John * @param name Name of the user * @return Greeting message */ function greetUser(name) < return `Greetings, $!`; > 

Эти комментарии называются DocStrings, поскольку они по сути являются строками (комментариями), составляющими документацию вашего кода.

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

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

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

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

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

Рассмотрим следующий код:

console.log("Working code"); console.log("Erroneous code); 

Если мы хотим удалить второй оператор, но не хотим удалять его навсегда, мы можем просто закомментировать его:

console.log("Working code"); //console.log("Erroneous code); 

Совет: в большинстве редакторов кода мы можем использовать сочетание клавиш Ctrl + / для Windows и Cmd + / для Mac, чтобы закомментировать одну строку кода.

Кроме того, вы также можете закомментировать целые разделы, если не уверены, удалять ли их или нет:

/*console.log("Entering for loop"); for (let i = 0; i < 100; i++) < console.log(i); >*/ 

Хорошие практики комментирования

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

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

Еще один совет — не писать очевидные и излишние комментарии. Например, совершенно не нужен следующий комментарий:

// Prints out the result console.log(result) 

Существуют полезные инструменты, такие как JSDOC 3, которые могут создавать документацию только на основе комментариев в вашем коде, которые отформатированы как DocStrings, описанные выше.

Вывод

В этой статье мы рассмотрели, что такое комментарии и как их создавать в JavaScript. Мы рассмотрели различные типы комментариев — однострочные и многострочные комментарии, а также строки документации JavaScript.

Мы также увидели, как отлаживать наш код, используя технику, называемую «комментирование», и, наконец, подытожили некоторые хорошие практики комментирования.

Комментарии

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

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

Видео​

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

React Native​

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

Проблемы?​

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

Вопросы:​

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

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

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

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

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

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

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

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

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):

JavaScript. Комментарии (однострочные, многострочные, теги)

Чтобы закомментировать одну строку в коде JavaScript, перед ней необходимо вставить одиночный (непарный) тег в виде двух наклонных линий (двойной слэш): //.

/ / Объявляем переменную с именем myInt
/ / Присваиваем переменной myInt значение 4

Однострочный комментарий можно вставлять в конце строки с кодом:

var myInt / / Объявляем переменную с именем myInt
myInt = 4 / / Присваиваем переменной myInt значение 4

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

Для выделения многострочных комментариев используются двойные (парные) теги: открывающий: /* и закрывающий: */.

/ * Для объявления переменной и присвоения ей
значения можно использовать не две строки :
var myInt = 4

Или так, для большей наглядности:

Для объявления переменной и присвоения ей
значения можно использовать не две строки :
var myInt = 4

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

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