Комментирование кода не только позволит вам самому понять, что же вы тут наворотили, но и другим существенно облегчит работу с вашим кодом. Кроме того, с помощью комментирования можно быстро отключать те части кода, которые вы еще не закончили, но уже добавили на страницу, что полезно при тестировании. Научитесь правильно комментировать, сделайте жизнь проще себе и окружающим!
Шаги
-
Однострочный комментарий. Такие комментарии оформляются тегами . Такие комментарии можно быстро без особых сложностей, чтобы напоминать себе, что делает тот или иной фрагмент кода.
< html > < head > < title > Заголовок </ title > </ head > < body > <!-- Это абзац --> < p > Сайт </ p > </ body > </ html >
- Главное - без пробелов тут. Например, код < !-- не активирует комментарий. Между тегами, впрочем, пробелов можно поставить сколько угодно.
-
Многострочный комментарий. Такие, как понятно из названия, захватывают уже несколько строк, что полезно для объяснения сложных участков или блокирования курпных частей кода.
< html > < head > < title > Заголовок </ title > </ head > < body > <!-- Длинный комментарий. Все, что между тегами, будет обработано браузером как комментарий. --> < p > Сайт </ p > </ body > </ html >
-
Используйте комментарии для отключения фрагментов кода. Пытаясь поймать хитрый баг (ошибку), можно использовать комментарии для последовательного перебора кода. Так вам будет куда проще вернуть все обратно - для этого нужно будет лишь удалить код комментария.
< html > < head > < title > Заголовок </ title > </ head > < body > < p > Проверка изображений </ p > < img src = "/images/image1.jpg" > <!-- Спрячу-ка я это <img src="/images/image2.jpg"> --> </ body > </ html >
-
Используйте комментарии для предотвращения запуска скриптов в не поддерживающих их браузерах. Если вы пишете на JavaScript или VBScript, то можете с помощью комментариев прятать скрипты от браузеров, которые их все равно не поддерживают. Вставьте тег комментария в начало скрипта, закончите все//-->, чтобы скрипт все же запустился - но лишь в тех браузерах, которые смогут это сделать.
< html > < head > < title > VBScript </ title > </ head > < body > < script language = "vbscript" type = "text/vbscript" > <!-- document . write ( "Hello World!" ) //--> </ script > </ body > </ html >
- Символы // в конце строки не дадут браузеру запустить скрипт, если тот не сможет его выполнить.
Реклама
Советы
- Комментируйте почаще, чтобы не запутаться через какое-то время в собственном коде.
Реклама
Реклама