Комментарий javascript – JavaScript – High-level, interpreted programming language. It is a language which is also characterized as dynamic, weakly typed, prototype-based and multi-paradigm / Habr

Комментарии JavaScript — Как создать сайт

Какие существуют комментарии в JavaScript

Статья
Комментарии в языке JavaScript

В языке JavaScript существуют два вида комментариев:
— однострочные // и
— многострочные /* */

Комментарии JavaScript располагают внутри кода JavaScript, между тегами <script> </script> или в файле .js

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

Однострочный комментарий, начинается с двойного слэша // и действует на всю строку, после слэша.

Пример использования однострочнного комментария (комментарии выделены красным цветом):

<script>
 // Это однострочный комментарий
 JavaScript-код;
 
 JavaScript-код; // Это однострочный комментарий
</script>

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

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

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

Пример использования многострочнного комментария:

<script>
 /*
  Это многострочный комментарий 
  который можно расположить на
  нескольких строках
 */

 /* А можно и на одной */

 JavaScript-код;
</script>

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

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

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

Читать далее: Лексическая структура JavaScript

Дата публикации поста: 5 февраля 2016

Дата обновления поста: 16 октября 2014

Навигация по записям

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

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

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

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

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

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

 // Изменим заголовок:
 document.getElementById("myH").innerHTML = "Моя первая веб-страница";
 // Изменим параграф:
 document.getElementById("myP").innerHTML = "Мой первый параграф."; 

В следующем примере одностроччный комментарий используется в конце каждой строки для пояснения JavaScript кода:

 var x = 5;      // Декларируем переменную x и присваиваем ей значение 5
 var y = x + 2;  // Декларируем переменную y и присваиваем ей значение x + 2 

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

Для определения многострочного комментария используется конструкция /*…*/. Любой текст, находящийся между /* и */ будет игнорироваться обработчиком JavaScript.

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

 /*
 Код ниже изменит
 на моей веб-странице
 заголовок с id = "myH"
 и параграф с id = "myP":
 */
 document.getElementById("myH").innerHTML = "Моя первая веб-страница";
 document.getElementById("myP").innerHTML = "Мой первый параграф."; 

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

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

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

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

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

 //document.getElementById("myH").innerHTML = "Моя первая веб-страница";
 document.getElementById("myP").innerHTML = "Мой первый параграф."; 

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

 /*
 document.getElementById("myH").innerHTML = "Моя первая веб-страница";
 document.getElementById("myP").innerHTML = "Мой первый параграф."; 
 */

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

Зачем нужны комментарии в JavaScript

Комментарии — это пояснения в программному коду, записанные прямо к коде.

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

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

В чужом скрипте очень просто разобраться, если он насыщен грамотными комментариями, подробно объясняющими алгоритм сценария.

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

Типы и синтаксис комментариев JavaScript

В JavaScript комментарии бывают однстрочные и многострочные.

Пример однострочного комментария:

<html>
<head>
	<title>Комментарии в JavaScript</title>
	<script type="text/javascript">
		// Комментарий: создаём переменную i и присваиваем ей значение.
		var i = "Привет, Мир!"
	</script>
</head>
<body>
<script type="text/javascript">
	// Комментарий: переменная i задана в блоке <head>.
	document.write(i)
</script>

<noscript>
	Ваш браузер не поддерживает JavaScript или поддержка отключена в настройках.
</noscript>
</body>
</html>
 

Пара прямых слэшей // сообщает обработчику JavaScript о том, что текст следующий за ними до знака переноса строки — это комментарий.

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

<html>
<head>
	<title>Комментарии в JavaScript</title>
	<script type="text/javascript">
		var i = "Привет, Мир!"
	</script>
</head>
<body>
<script type="text/javascript">
/*
	Комментарий: переменная i задана в блоке <head>.
	Теперь она будет выведена на экран командой document.write(i).
*/
document.write(i)
</script>

<noscript>
	Ваш браузер не поддерживает JavaScript или поддержка отключена в настройках.
</noscript>
</body>
</html>

Для создания многострочного комментария, как и в CSS, применяется консрукция /* … */. Всё что находится между /* и */ будет проигнорировано обработчиком JavaScript.

Как и в CSS, в JavaScript запрещены вложенные комментарии. Вам будет весьма полезно прочитать статью комментарии в CSS и понять пример приведённый в ней.

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

Предотвращаем исполнение кода

<html>
<head>
	<title>Комментарии в JavaScript</title>
</head>
<body>
<script type="text/javascript">
	document.write("<h2>Привет, Мир!</h2>")
	document.write("<p>Новый день наступил.</p>")
	// document.write("<p>Новый день = новые возможности!</p>")
</script>
</body>
</html>

В этом примере третья команда document.write() не выведет свой сообщение: «Новый день = новые возможности!», так как она закомментирована.

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

<html>
<head>
	<title>Комментарии в JavaScript</title>
</head>
<body>
<script type="text/javascript">
	document.write("<h2>Привет, Мир!</h2>")
	/*
		document.write("<p>Новый день наступил.</p>")
		document.write("<p>Новый день = новые возможности!</p>")
	*/
</script>
</body>
</html>
 

В этом примере на экране будеттолько сообшение «Привет, Мир!». Все остальные инструкции сценария не выполнятся, так как они закомментированы многострочным комментарием /* … */.

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

Для объяснения логики алгоритма удобно писать комментарии к каждой строке. Вот простой пример как это делается.

<html>
<head>
	<title>Комментарии в JavaScript</title>
</head>
<body>
<script type="text/javascript">
	document.write("<h2>Привет, Мир!</h2>") // Выводит "Привет, Мир!"
	document.write("<p>Новый день наступил.</p>") // Выводит "Новый день наступил."
	document.write("<p>Новый день = новые возможности!</p>") // Выводит "Новый день = новые возможности!"
</script>
</body>
</html> 

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

---

---

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

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

---

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

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

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

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

Пример

// Изменить заголовок:
document.getElementById(«myH»).innerHTML = «Моя Первая Страница»;
// Изменить параграф:
document.getElementById(«myP»).innerHTML = «Мой первый параграф.»;

Редактор кода »

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

Пример

var x = 5;      // Объявить x, присвоить значение 5
var y = x + 2;  // Объявить y, присвоить значение x + 2

Редактор кода »

---

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

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

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

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

Пример

/*
Ниже код изменится
заголовок в id = «myH»
и параграф в id = «myP»
на моей веб странице:
*/
document.getElementById(«myH»).innerHTML = «Моя Первая Страница»;
document.getElementById(«myP»).innerHTML = «Мой первый параграф.»;

Редактор кода »

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

---

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

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

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

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

Пример

//document.getElementById(«myH»).innerHTML = «Моя Первая Страница»;
document.getElementById(«myP»).innerHTML = «Мой первый параграф.»;

Редактор кода »

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

Пример

/*
document.getElementById(«myH»).innerHTML = «Моя Первая Страница»;
document.getElementById(«myP»).innerHTML = «Мой первый параграф.»;
*/

Редактор кода »

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

---

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

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

---

ОДНОЛИНЕЙНАЯ Комментарии

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

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

Этот пример использует одну строку комментария перед каждой строкой, чтобы объяснить код:

пример

// Change heading:
document.getElementById(«myH»).innerHTML = «My First Page»;
// Change paragraph:
document.getElementById(«myP»).innerHTML = «My first paragraph.»;

Попробуй сам »

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

пример

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

Попробуй сам »

---

Многоканальный Комментарии

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

Любой текст между /* и */ будет проигнорирован 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.»;

Попробуй сам »

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

---

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

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

Добавление , // в