Разное

Комментарий js: Комментарии

Содержание

Комментарии 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

В 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 Комментарии | Schoolsw3.com



Комментарии 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 команд. Часто их прописывают там, где должна находиться 1 JavaScript инструкция, но её одной может не хватить. Звучит странно, но в следующих статьях мы поговорим об этом подробнее.

Ещё одно применение точек с запятой — разделение скриптов. Чаще всего, перед выпуском готовой версии сайта, файлы с кодом сжимаются. Вследствие этого скрипты сжимаются в один JavaScript файл.

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

На первый взгляд — обычный код, но как вы могли заметить в начале каждого блока проставлена точка с запятой. Именно она и разделяет разные скрипты в JavaScript файле

Логические инструкции в Javascript

Теперь давайте подробно разберемся в работе некоторых инструкций. Начнем мы с логических операторов.

Самая главная команда логической конструкции — if. Не нужно быть знатоком английского языка чтобы знать, что это слово переводится как «если».

Работа логической конструкции базируется на следующем принципе: «если соблюдается определенное условие, то будет выполнена следующая операция».

Кроме простого «если» существуют команды «иначе» и «иначе если». «Иначе» или else используется для создания простой логической конструкции из 2-х условий. Когда же применяется команда else if, то это говорит нам о том, что условий может быть много, от 3-х и более.

Пример сложной логической конструкции:

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

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

Команды циклов в Javascript

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

Для чего предназначены циклы? Их основная задача — повторение одного и того же кода определенное количество раз.

Существует 2 основных типа циклов:

  1. While;
  2. For;

Первый тип — while, работает пока заданное условие является верным. Проще говоря, если вы задали такое условие: «Переменная i меньше трех» — цикл будет выполняться пока переменная i меньше трех. Цикл зависит только от этой переменной, и если её не увеличивать до трех, цикл будет длиться бесконечно.

Есть ещё цикл «do… while» — практически одно и то же. Единственная разница в том, что в простом цикле while сначала проверяется условие, а уже потом совершается работа кода. Во втором случае всё наоборот — сначала начинает работать тело цикла, а уже потом совершается условие.

Второй тип — for, который является наиболее популярным среди всех JavaScript, и не только, разработчиков. Его условная конструкция выглядит так: «начало; условие; шаг».

  1. Начало — здесь вводится исходное значение условной переменной. Например — i=0.
  2. Условие — здесь вводится условие цикла. Например — i>3.
  3. Шаг — здесь вводится то значение, которое будет прибавляться к условной переменной или вычитаться из неё. Например — i++(i+=1).

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

Пару слов о комментариях в Javascript

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

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

Заключение

В этой статье мы узнали основную информацию о работе циклов и условных конструкций, а также научились ставить комментарии.

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

Удачи в изучении!

Теги:

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

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

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

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



// Изменить заголовок:

document.getElementById(«myH»).innerHTML = «Первая страница»;

// Изменить абзаца:

document.getElementById(«myP»).innerHTML = «Первый параграф.»;

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

var x = 5; // объявляем х, присваиваем ему значение 5
var y = x + 2; // объявляем y , присваиваем ему значение x + 2



var x = 5;      // объявляем х, присваиваем ему значение 5

var y = x + 2;  // объявляем y , присваиваем ему значение x + 2

Многострочные комментарии
Многострочные комментарии начинаются с /* и заканчиваются*/.
Любой текст между /* и */ будет игнорироваться JavaScript.
В этом примере используется многострочный комментарий (блок комментариев) для объяснения кода:

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



/*

Ниже код изменится

заголовок с 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 = «Первый абзац.»;

Для комментирования нескольких строк:

/*
document.getElementById(«myH»).innerHTML = «Первая страница»;
document.getElementById(«myP»).innerHTML = «Первый абзац.»;
*/



/*

document.getElementById(«myH»).innerHTML = «Первая страница»;

document.getElementById(«myP»).innerHTML = «Первый абзац.»;

*/

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

Комментарии в JavaScript. Однострочные и многострочные комментарии. Теги, применяемые для выделения комментариев в зависимости от количества строк.

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

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

Пример кода:

// Объявляем переменную с именем myInt

var myInt

// Присваиваем переменной myInt значение 4

myInt = 4

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

var myInt // Объявляем переменную с именем myInt

myInt = 4 // Присваиваем переменной myInt значение 4

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

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

Пример кода:

/* Для объявления переменной и присвоения ей

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

var myInt

myInt = 4,

а одну: */

var myInt = 4

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

/*

Для объявления переменной и присвоения ей

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

var myInt

myInt = 4,

а одну:

*/

var myInt = 4

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

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

Комментарии в HTML-, CSS-, JS- и PHP-коде

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

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

Комментарии в HTML-разметке

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

<!-- Текст, код или прочее -->

Все, что стоит в этих тегах, не видно на экране, но доступно для просмотра в исходном коде.

Комментарии в CSS-стилях

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

/* Текст, код или прочее */ 

Все, что стоит в этих тегах, не учитывается при формировании стилей, но доступно для просмотра в самом файле стилей.

Комментарии в JavaScript-коде

Для добавления комментариев в JavaScript существуют два их типа.

Первый тип:

// Текст, код или прочее

Второй тип:

/* Текст, код или прочее */ 

Все, что стоит в этих тегах, не учитывается при выполнении скрипта, но доступно для просмотра в самом файле JavaScript.

Комментарии в PHP-коде

Этот язык программирования, в отличие от предыдущих, имеет 3 типа комментариев.

Первый тип:

// Текст, код или прочее 

Второй тип:

/* Текст, код или прочее */

И третий тип:

# Текст, код или прочее

Все, что стоит в этих тегах, не учитывается при выполнении скрипта и видно только в самом файле PHP.

Обратите внимание!

1. Не рекомендуется делать двойное вложение комментариев. Например,

/* /* Мой код */ */ 

выведет вам ошибку.

2. Комментарии, которые пишутся через /* */ и <!— —>, могут писаться в несколько строк:

/* 
Это 
Мой 
Код 
*/ 

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

// Это 
// Мой 
// Код 

В противном случае вы также обнаружите ошибку.

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

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

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

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

Комментарии JavaScript Начало внутри кода JavaScript, между тегами или в файле .js

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

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

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

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

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

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

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

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

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

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

 JavaScript-код;
 

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

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

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

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

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

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

Навигация по алгоритму

.

JavaScript Комментарии | Schoolsw3.com



Комментарии 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 = «Моя Первая Страница»;
документ.getElementById («myP»). innerHTML = «Мой первый параграф.»;

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

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

Пример

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

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

.

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *