Может показаться что эту тему вообще не стоит разбирать. И в самом деле, какие проблемы могут возникнуть при написании комментария? Взял, написал, опубликовал и начал собирать ответы и лайки) Такой подход отлично работает в соцсетях и форумах, но не в языках программирования.
Начнем с комментария в HTML
Его структура довольно проста: угловые скобки, один восклицательный знак, по два тире с каждой стороны и текст комментария между ними.
Теперь переходим к комментарию в CSS
Здесь мы имеем похожую структуру: два слеша, две звездочки и текст комментария между ними.
Остается разобраться с комментариями в JavaScript
В JS существует два вида комментариев: однострочные (слово, словосочетание или короткое предложение) и многострочные (длинное предложение в две и более строки, абзац и т.д.). Каждый из этих видов оформляется по разному.
Однострочный комментарий:
Данную структуру можно считать простейшей, т.к. она имеет всего одну основную составляющую: двойной слеш.
Многострочный комментарий:
Как видно из примера многострочный комментарий в JS по своему внешнему виду практически ничем не отличается от комментария в CSS.
Итак, подведем небольшой итог. Прописывать комментарии занимаясь разметкой или программированием необходимо. Это позволит Вам (и не только Вам) лучше и быстрее ориентироваться в написанном коде. Причем неважно сколько пройдет времени с момента последнего обращения к нему: неделя, месяц, год. Если код изначально был снабжен толковыми комментариями то вспомнить что к чему относится и что за что отвечает не составит никакого труда.
Спасибо за внимание!
Надеюсь все получилось и теперь Вы сделаете свой сайт гораздо более красочным и интересным.
Предлагаю подписаться на канал и следить за выходом новых интересных статей.