Главная страница » JavaScript » 2. Комментарии

2. Комментарии

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

В JavaScript есть два типа комментариев: однострочные и многострочные.

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

Однострочные комментарии начинаются с двух косых черт (//). Всё, что находится после этих символов до конца строки, считается комментарием и игнорируется интерпретатором.

Пример:

				
					// Это однострочный комментарий
let message = "Привет, Мир!"; // Это тоже однострочный комментарий

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

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

Пример:

				
					/* 
   Это многострочный комментарий.
   Он может занимать несколько строк.
*/
let message = "Привет, Мир!";

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

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

				
					// Функция для сложения двух чисел
function add(a, b) {
    return a + b;
}

Описание функций и переменных: Вы можете использовать комментарии для описания назначения функций и переменных.

				
					// Переменная для хранения имени пользователя
let userName = "Алиса";

// Функция для приветствия пользователя
function greetUser(name) {
    alert("Привет, " + name + "!");
}

Отключение кода: Иногда полезно временно отключить часть кода без его удаления. Для этого можно использовать комментарии.

				
					let message = "Привет, Мир!";
// alert(message); // Временное отключение вызова alert

Распространённые ошибки

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

				
					// Правильно
let message = "Привет, Мир!"; // Это комментарий

/* Правильно
Это многострочный комментарий
*/

// Неправильно
let message = "Привет, Мир!" // Это комментарий
*/

Комментарии внутри строк: Не используйте символы комментариев внутри строк, так как это может привести к неожиданным результатам.

				
					// Неправильно
let message = "Привет, // Мир!"; // Это не комментарий, а часть строки

Заключение

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

Тестовое задание

Создайте HTML-документ с подключенным внутренним скриптом, содержащим несколько однострочных и многострочных комментариев, объясняющих код.
Напишите функцию multiply(a, b), которая возвращает произведение двух чисел. Используйте комментарии для описания назначения функции и её параметров.
Включите вызов функции multiply в коде, но временно отключите его с помощью комментариев.

Пример выполнения:

HTML:

				
					<!DOCTYPE html>
<html>
<head>
    <title>Комментарии в JavaScript</title>
    <script>
        // Это однострочный комментарий
        let message = "Привет, Мир!";

        /*
           Это многострочный комментарий.
           Он может занимать несколько строк.
        */
        
        // Функция для умножения двух чисел
        function multiply(a, b) {
            return a * b; // Возвращает произведение a и b
        }

        // Вызов функции умножения
        // alert(multiply(2, 3)); // Временно отключен
    </script>
</head>
<body>
    <h1>Комментарии в JavaScript</h1>
</body>
</html>

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