Комментарии в JavaScript — это инструкции, которые мы пишем как часть нашего кода, чтобы сообщить что-то людям. Это понятные для человека описания или пояснения кода, которые мы добавляем в код нашего скрипта, чтобы упростить понимание и поддержку скрипта.
Комментарии на JavaScript позволяют программистам самостоятельно составлять и выражать свои мысли, связанные с кодом скрипта. Хорошей привычкой является написание комментариев, связанных с кодом скрипта в программе на JavaScript. Это также может быть полезно, когда кто-то пытается понять код скрипта.
Например, вот комментарий, который выражает значение, используемое для инициализации переменной «x»:
let x = 50; // Variable declaration and initialization.
Этот комментарий объясняет объявление и инициализацию переменной значением. Комментарии в JavaScript также могут быть полезны для скрытия программного кода.
Как и в других языках, комментарии на JavaScript полностью игнорируются интерпретатором JavaScript, встроенным в браузер. То есть комментарии не выполняются, как все другие коды, которые мы пишем. JavaScript полностью игнорирует комментарии.
Типы комментариев в JavaScript
В JavaScript есть два типа комментариев. Они следующие:
- Однострочный комментарий
- Многострочный комментарий
Давайте разберемся с примерами один за другим.
Однострочные комментарии
Однострочный комментарий представлен двойной косой чертой (//). Его можно использовать до и после текста. То есть размещение двух косых черт (//) до и после инструкции делает ее однострочным комментарием.
Давайте рассмотрим простой пример, в котором мы поместим однострочный комментарий перед оператором.
<script>
// This is a single line comment.
document.write("JavaScript Programming");
</script>
Мы также можем написать однострочный комментарий в виде одной строки как:
let x = 25; // Here, x is a variable that is initialized with a value.
Давайте возьмем простую программу на JavaScript, в которой мы напишем однострочный комментарий до и после операторов.
Пример 1:
<DOCTYPE html>
<html>
<head>
<title>Single Line Comment Example</title>
</head>
<body>
<script>
// Variables declaration and initialization.
var x = 20;
var y = 30;
var z = x+y ; // It will add the values of variables.
document.write("Sum: " +z); // This statement will print the sum of two numbers.
</script>
</body>
</html>
Вывод кода: Сумма: 50
Многострочный комментарий
Иногда однострочного комментария недостаточно для описания скрипта, который мы хотим предоставить. В такой ситуации мы можем использовать многострочный комментарий.
Многострочные комментарии начинаются с /* и заканчиваются */. Любое утверждение между /* и */ будет рассматриваться как многострочный комментарий и игнорируется механизмом JavaScript.
Ниже приведен пример многострочного комментария:
/* This is multiline comment.
It will not be executed by JavaScript interpreter. */Давайте возьмем простую программу на JavaScript, в которой мы напишем многострочный комментарий для предоставления информации о коде.
Пример 2:
<DOCTYPE html>
<html>
<head>
<title>Multi-Line Comment Example</title>
</head>
<body>
<script>
/* JavaScript is a simple web programming to display
text in a browser. */ document.write("Hello! I am Deepak and a Web programmer in class 10." +"<br>");
document.write("I am in RSVM, Dhanbad");
</script>
</body>
</html>
Вывод кода: Здравствуйте! Меня зовут Дипак, я веб-программист из 10 класса. Я нахожусь в RSVM, Дханбад.
Использование комментариев для предотвращения выполнения кода
Мы также можем использовать комментарии для запрета выполнения кода, это подходит для тестирования кода. Размещение двойной косой черты (//) перед строкой кода преобразует строку исполняемого кода в строку комментария.
В приведенном ниже примере используется // для предотвращения выполнения одной из строк кода:
<script>
document.write("Hello! JavaScript World"); // Executable code line.
// document.write("Hello! JavaScript World"); // Now, it is a comment line.
</script>
Рекомендации по комментированию
Давайте укажем на некоторые важные моменты о том, как правильно использовать комментарии, чтобы сделать наш код легким для чтения:
1. Всегда комментируйте свой код во время его написания. Написание комментариев может быть для вас скучным занятием, но это важная часть кода.
2. Не откладывайте комментарии на потом, когда вы пишете код. Это нехорошо.
3. Используйте больше английских слов и меньше JavaScript.
4. Не усложняйте свой комментарий кодом без необходимости. Будьте ясны и лаконичны.
5. Если строка кода говорит сама за себя, не тратьте свое время на комментарии к очевидному коду.
Вот несколько важных моментов, которые вы должны иметь в виду для получения наилучших практик.
Преимущество комментариев на JavaScript
Добавление комментариев, которым следует код скрипта, имеет много преимуществ. Это:
1. Комментарии на JavaScript помогают сделать код скрипта более читабельным и понятным.
2. Это помогает программистам сделать скрипт ремонтопригодным.
3. Комментарии также помогают скрыть ненужный код. Иногда мы добавляем код скрипта для выполнения какой-либо функции. Но через некоторое время функция может оказаться ненужной, и потребуется отключить код. В таком случае комментарии помогают скрыть код, комментируя код скрипта.
