Определение комментария
Комментарий - инструкция, содержимое которой интерпретатор игнорирует т.е. не выполняет, следовательно, что бы вы не записали в комментарий, на работу программы он прямо не повлияет. Для того чтобы создать комментарий нужно написать два слэша // и далее, любой набор символов, который следует после них будет считаться комментарием.
|
1 |
//Это однострочный комментарий |
Существует два типа комментариев: однострочный и многострочный (блочный). Однострочный мы уже рассмотрели, а многострочный комментарий определяется с помощью пар символов /* */.
|
1 2 3 |
/*Это многострочный комментарий*/ |
Необходимость комментариев
Комментарии нужны в первую очередь для упрощения понимания кода. В комментариях записывается информация, например о том, что именно происходит в определенном участке кода, т.к. это не всегда очевидно, даже для самого создателя кода (когда проходит достаточно много времени становится труднее разобраться в собственном коде).
|
1 2 3 4 5 6 7 8 9 10 11 12 |
/*Код программы, которая вычисляет факториал значения, которое передано в параметр n функции factorial(n)*/ function factorial(n) { //Инициализация (объявление) функции с параметром n if (n === 0) { //Если значение параметра = 0, то функция получит результат = 1 return 1; } return n * factorial(n - 1); //Если значение параметра отлично от нуля, то функция получит результат вычисления } factorial(5); //Вычисляем факториал 5, в результате функция вернет нам результат = 120 |
Также комментарии часто используют для "выключения" ненужных в данный момент строк кода.
|
1 2 3 4 5 6 7 8 9 |
var Russia = { territory: "17,075,400 square kilometres", population: "144 million", /*capital: "Moscow", currency: "Russian ruble",*/ officialLanguage: "Russian" } //console.log(Russia.capital); //console.log(Russia.currency); |
Комментарии сильно помогут вам в будущем и тем людям, которые будут читать ваш код, поэтому при написании каких либо программ старайтесь часто использовать комментарии в трудно понятных участках кода с как можно понятным объяснением их работы.