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

• May 5, 2024

Комментарии - это просто комментарии, которые вы добавляете в свой JavaScript или HTML, чтобы объяснить, что происходит. Есть несколько способов добавить комментарии в ваш код JavaScript. Синтаксис комментариев - как сообщить сценарию или документу, что что-то является комментарием, а не данными или кодом - очень просто. Написание хороших комментариев сложнее, и, глядя на код (включая мой собственный), кажется, что самое сложное - это сделать!

JavaScript имеет 2 типа комментариев, однострочный комментарий и многострочный комментарий.

Однострочный комментарий в JavaScript начинается с двух косых черт (//) и заканчивается в конце строки (технически, непосредственно перед символом конца строки). Однострочные комментарии особенно полезны для коротких заметок.

// Это однострочный комментарий
data = "my data" // Это также однострочный комментарий

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

/ * это первая строка многострочного комментария
это все еще часть моего комментария
это последняя часть моего комментария * /

/ * это многострочный комментарий в одной строке * /

Вы часто видите дополнительные звездочки, добавленные к многострочным комментариям для создания декоративных информационных блоков, таких как:

/*********************
* Мои функции *
*********************/

Многострочные функции особенно полезны в начале программы или раздела программы для описания того, для чего предназначена программа и как она это делает.

Комментарии используются для двух целей. Когда вы пишете код (или даже прежде, чем напишите его!), Вы должны писать комментарии, которые позволят другому человеку понять, что делает программа (или должна была делать). Даже если вы не ожидаете, что кто-то еще когда-либо будет читать ваш код, вы будете удивлены, сколько вы можете забыть, если вы хотите внести изменения через несколько недель или месяцев.

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

Видео инструкция: JavaScript Решает 29. Система комментариев для сайта (May 2024).