Изучаем комментарии в CSS

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

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

ВЛ Виктория Лебедеваавтор материала

Как добавить CSS комментарий

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

•	Начните свой комментарий, добавив /*
•	Закройте комментарий, добавив  */

Он может быть однострочным или многострочным.

Однострочный комментарий CSS:

div#border_red {    
  border: thin solid red;      
} /* красная граница пример */
И многострочный пример:
/*************************** 
**************************** 
Многострочный комментарий
**************************** 
***************************/

Разделение на секции

Часто я использую CSS комментарии в коде для структуризации стилей. Чтобы сделать это, я добавляю комментарии с большим количеством дефисов. Они формируют более очевидные разрывы на странице. Вот пример:

/*----------------------- Заголовок начинается здесь ------------------------------ */

«Комментирование» кода в CSS

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

Поскольку комментирующие теги сообщают браузеру о том, что нужно игнорировать все, что находится между ними. Благодаря этому их можно использовать для временного отключения некоторых частей кода CSS.

Советы по CSS комментированию

  1. Комментарии могут занимать несколько строк;
  2. Комментарии могут включать в себя CSS элементы, которые не нужно отображать в браузере и удалять полностью. Это хороший способ отладки стилей сайта;
  3. Используйте комментарии, когда пишете сложный CSS, чтобы добавить разъяснения и сообщить разработчикам о нюансах, которые стоит знать;
  4. Комментарии в HTML CSS могут также включать в себя такую метаинформацию, как:
  • Автор;
  • дата создания;
  • информация об авторских правах.

Эффективность

Комментарии, безусловно, полезны. Но имейте в виду, что чем больше комментариев вы добавляете в код, тем больше увеличивается его объем, а это влияет на скорость загрузки и производительность сайта.

ВЛ Виктория Лебедеваавтор-переводчик статьи «How to Insert a CSS Comment»

Комментарии

Оставьте свой комментарий
Пока никто не оставил комментариев