13-10-2018 11:25

Комментарии в CSS: правила использования

Использование комментариев в коде всегда считалось хорошим тоном среди программистов. Это облегчает восприятие кода, помогает разделить его на логические блоки и особенно помогает в совместной работе над каким-либо проектом. В этой статье рассмотрим, как правильно использовать комментарии в CSS.

Что такое комментарии в коде и зачем они нужны?

Существуют общепринятые способы сделать код более читабельным и легким для восприятия — табуляция, использование пробелов и, разумеется, комментирование кода. Комментарии в CSS-коде выделяются специальными символами и не являются исполняемыми тегами, то есть браузер их игнорирует, они несут только информационную нагрузку.

How dangerous is the new coronavirus?You will be interested:How dangerous is the new coronavirus?

Мы расскажем, каким образом грамотно прокомментировать ваш код.

Синтаксис комментариев

Для того, чтобы браузер не воспринимал информацию из блока с комментарием, а только отображал данные, используется следующий синтаксис:

.block { color: #000000; text-decoration: underline; /*этот текст будет подчеркнутым*/ font-style: italic; }

То есть текст заключается в конструкцию /*...*/. Браузер не будет воспринимать комментарии в CSS в качестве элементов, которые следует исполнять. Они могут располагаться в любом месте документа.

Очень часто CSS-код в ходе работы над проектом становится длинным, с большим количеством разнообразных блоков — один, к примеру, описывает шапку сайта, следующий — поля ввода текста и так далее. Для того, чтобы аккуратно выделить каждый из таких блоков, тоже можно использовать комментарий. Многие разработчики делают это так следующим образом.

/* ------------------Это левая часть------------------*/ #left { background: red; width: 20%; height: 100%; } /* ------------------Это правая часть------------------*/ #right { background: green; width: 80%; height: 100%; }

То есть сам комментарий выделяется при помощи дефисов, чтобы визуально выделить ту часть работы, которую требуется отметить.

Правила создания и использования комментариев

Комментарий в CSS может быть как многострочным, так и однострочным, это не регламентировано. Важно лишь то, что указано между открывающим и закрывающим тегом.

Иногда требуется отключить какой-то отрывок кода, чтобы проверить, каким образом форматирование будет отображаться в браузере без него. Достаточно неудобно каждый раз копировать его в новый документ, есть риск потерять его из буфера обмена — в таком случае проще всего заключить его в синтаксис комментария.

Комментарии в CSS могут состоять из любого набора текстовых, числовых или символьных обозначений, нет разницы, на каком языке они выполнены.

Вложенные комментарии не поддерживаются, запрещено использовать один комментарий внутри другого.

Комментирование используется в следующих случаях:

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



    Источник