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


Оглавление

    Показать оглавление


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

Комментарии JavaScript также можно использовать для предотвращения выполнения, когда тестирование альтернативного кода.


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

Однострочные комментарии начинаются с //.

Любой текст между // и концом строки будет игнорироваться JavaScript. (не будет выполнено).

В этом примере перед каждой строкой кода используется однострочный комментарий:

Пример

// Change heading:
document.getElementById("myH").innerHTML = "My First Page";

// Change paragraph:
document.getElementById("myP").innerHTML = "My first paragraph.";

Попробуйте сами →

<!DOCTYPE html>
<html>
<body>

<h1 id="myH"></h1>
<p id="myP"></p>

<script>
// Change heading:
document.getElementById("myH").innerHTML = "JavaScript Comments";
// Change paragraph:
document.getElementById("myP").innerHTML = "My first paragraph.";
</script>

</body>
</html>

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

Пример

let x = 5;      // Declare x, give it the value of 5
let y = x + 2;  // Declare y, give it the value of x + 2

Попробуйте сами →

<!DOCTYPE html>
<html>
<body>

<h2>JavaScript Comments</h2>

<p id="demo"></p>

<script>
let x = 5;      // Declare x, give it the value of 5
let y = x + 2;  // Declare y, give it the value of x + 2 

// Write y to demo:
document.getElementById("demo").innerHTML = y;
</script>


</body>
</html>

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

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

Любой текст между /* и */ будет игнорироваться JavaScript.

В этом примере для пояснения кода используется многострочный комментарий (блок комментариев):

Пример

/*
The code below will change
the heading with id = "myH"
and the paragraph with id = "myP"
in my web page:
*/
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
 

Попробуйте сами →

<!DOCTYPE html>
<html>
<body>

<h1 id="myH"></h1>
<p id="myP"></p>

<script>
/*
The code below will change
the heading with id = "myH"
and the paragraph with id = "myP"
*/
document.getElementById("myH").innerHTML = "JavaScript Comments";
document.getElementById("myP").innerHTML = "My first paragraph.";
</script>

</body>
</html>

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



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

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

Добавление // перед строкой кода изменяет строки кода с исполняемой строки на комментарий.

В этом примере используется/для предотвращения выполнения одной из строк кода:

Пример

//document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";

Попробуйте сами →

<!DOCTYPE html>
<html>
<body>

<h2>JavaScript Comments</h2>

<h1 id="myH"></h1>

<p id="myP"></p>

<script>
//document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
</script>

<p>The line starting with // is not executed.</p>

</body>
</html>

В этом примере используется блок комментариев, чтобы предотвратить выполнение несколько строк:

Пример

/*
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
*/

Попробуйте сами →

<!DOCTYPE html>
<html>
<body>

<h2>JavaScript Comments</h2>

<h1 id="myH"></h1>

<p id="myP"></p>

<script>
/*
document.getElementById("myH").innerHTML = "Welcome to my Homepage";
document.getElementById("myP").innerHTML = "This is my first paragraph.";
*/
document.getElementById("myP").innerHTML = "The comment-block is not executed.";
</script>


</body>
</html>