Комментарии в JavaScript. Однострочные и многострочные комментарии. Теги, применяемые для выделения комментариев в зависимости от количества строк.
Однострочные комментарии в JavaScript
Чтобы закомментировать одну строку в коде JavaScript, перед ней необходимо вставить одиночный (непарный) тег в виде двух наклонных линий (двойной слэш): //.
Пример кода:
1 2 3 4 |
// Объявляем переменную с именем myInt var myInt // Присваиваем переменной myInt значение 4 myInt = 4 |
Однострочный комментарий можно вставлять в конце строки с кодом:
1 2 |
var myInt // Объявляем переменную с именем myInt myInt = 4 // Присваиваем переменной myInt значение 4 |
Многострочные комментарии в JavaScript
Для выделения многострочных комментариев используются двойные (парные) теги: открывающий: /* и закрывающий: */.
Пример кода:
1 2 3 4 5 6 |
/* Для объявления переменной и присвоения ей значения можно использовать не две строки: var myInt myInt = 4, а одну: */ var myInt = 4 |
Или так, для большей наглядности:
1 2 3 4 5 6 7 8 |
/* Для объявления переменной и присвоения ей значения можно использовать не две строки: var myInt myInt = 4, а одну: */ var myInt = 4 |
Используйте комментирование строк в JavaScript не только исключительно для написания комментариев, но и для отключения участков кода при отладке программ.
Комментарии в программировании — это пояснения к исходному тексту программы, которую вы пишете. Находятся они внутри комментируемого кода. Некоторые специалисты считают, что если для понимания программы требуются комментарии, значит, она плохо написана. Другие считают, что надо всегда комментировать свой код, и не только тот, который пишется для других, но и тот, который пишется для себя. Если первое время кажется, что прекрасно помнишь внутреннюю структуру и принцип работы своего кода, через неделю-две уже бывает трудно разобраться, а еще через какое-то время смотришь на свою программу, как на чужую. Чтобы этого не случилось и можно было быстро восстановить в памяти предыдущий ход мыслей, необходимо пошаговое комментирование своих действий.