Как вставить комментарий в файл css
Перейти к содержимому

Как вставить комментарий в файл css

  • автор:

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

Как и в HTML-страницы, в CSS файлы можно добавлять комментарии. Может ты хочешь оставить заметку для себя, а может хочешь помочь коллегам разобраться в каких-то сложных моментах.

Комментарии в CSS файле

В HTML, комментарием считается любой текст между . В CSS файлах эти символы заменяются на /* и */ соответственно. Например:

/* Это комментарий к стилям заголовка */ h1 < color: red; > 

Можно сделать комментарий из нескольких строк:

/* Это комментарий к стилям заголовка теперь он состоит из трех строк */ h1 < color: red; > 

Комментарии в HTML файле внутри тега

Интересной особенностью тега style является то, что внутри него комментарии добавляются точно так же, как и в файле CSS, несмотря на то, что пишем мы их в HTML документе:

head> title>Мой личный блогtitle> style> /* CSS комментарий */ h1 < color: red; > style> head> 

Как правильно вставить комментарий в файл CSS

Для вставки комментариев в файл CSS, нужно использовать следующую структуру: /* это комментарий */ . Данный формат является стандартным для CSS и большинства других C-подобных языков программирования.

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

Пусть у вас есть следующий блок кода:

body

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

/* Стилизация фона и цвета текста для всего сайта */ body

Комментарии в CSS игнорируются браузерами, поэтому он не повлияет на работу вашего кода.

Лучшие практики в использовании комментариев в CSS

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

Используйте комментарии для:

  • Описания общей структуры и логики вашего CSS кода.
  • Указания на особенности реализации определенных стилей или элементов.
  • Создания закладок для легкого навигирования по коду.

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

Комментарии в CSS

Нужно что-то скрыть, но не удалять? Хотите оставить пояснение или подсказку? Вам нужен комментарий.

Время чтения: меньше 5 мин

Открыть/закрыть навигацию по статье

Обновлено 6 августа 2021

Кратко

Скопировать ссылку «Кратко» Скопировано

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

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

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

Пример

Скопировать ссылку «Пример» Скопировано

В CSS существует только один вид комментариев, но их можно записывать по-разному.

 /* Комментарий-блок, если нужно расписать что-то подробно.*/ .block  /* Комментарий в строку */ text-align: center;> /* Комментарий-блок, если нужно расписать что-то подробно. */ .block  /* Комментарий в строку */ text-align: center; >      

Обратите внимание, что комментарий вида / / в начале строки в CSS не поддерживается, он работает только в препроцессорах, вроде Sass или Less.

Как пишется

Скопировать ссылку «Как пишется» Скопировано

Комментарий оформляется при помощи двух пар символов, /* и * / :

 /* Любой текст */ /* Любой текст */      

По желанию или в соответствии с принятым в вашей команде стилем кода после открывающих символов можно перенести текст на новую строку, и закрывающую пару тоже поставить на следующей новой строке. Как-то так:

 /* Я помню чудное мгновенье: Передо мной явилась ты, Как мимолетное виденье, Как гений чистой красоты.*/ /* Я помню чудное мгновенье: Передо мной явилась ты, Как мимолетное виденье, Как гений чистой красоты. */      

Как понять

Скопировать ссылку «Как понять» Скопировано

У комментария обязательно должны быть начало и конец. Открывать комментарий нужно при помощи /* , а закрывать — при помощи зеркальной конструкции * / .

Ещё пример

Скопировать ссылку «Ещё пример» Скопировано

Как выглядит закомментированное свойство:

 .block  /* height: 100%; */ width: 100%;> .block  /* height: 100%; */ width: 100%; >      

А вот так можно закомментировать целый блок:

 /* .block  width: 100%; height: 100%;> */ /* .block < width: 100%; height: 100%; >*/      

Иногда комментариями обозначают начало и конец смысловых блоков стилей:

 /* Header */.header  display: flex;>/* End Header*/ /* Footer */.footer  background-color: pink;>/* End Footer */ /* Header */ .header  display: flex; > /* End Header*/ /* Footer */ .footer  background-color: pink; > /* End Footer */      

В таком коротком куске кода комментарии избыточны и смотрятся грязно. Но когда файл со стилями состоит из тысяч строк (такого, конечно, стоит избегать), то такая навигация удобна.

Подсказки

Скопировать ссылку «Подсказки» Скопировано

�� Не злоупотребляйте комментариями. Не стоит пояснять всё подряд. Пишите комментарии только там, где без подсказки никак не понять, что происходит.

�� Но и не игнорируйте комментарии. Не молчите там, где есть что сказать. Например, вы использовали !important в коде (напомним, что это крайне нежелательная практика), но в данном случае он необходим. Поясните своё решение, чтобы следующий разработчик всё не сломал, удалив нежелательный элемент.

�� Чтобы быстро закомментировать или раскомментировать текущую строку или выделенный блок кода, в большинстве редакторов кода можно нажать Ctrl / или Cmd / .

На практике

Скопировать ссылку «На практике» Скопировано

Егор Левченко советует

Скопировать ссылку «Егор Левченко советует» Скопировано

�� Иногда в процессе разработки нужно быстро проверять какую-то гипотезу. Не хочется сгоряча удалять блок кода, вымученного кровью и потом. Просто закомментируй подозрительные строки. Если причина не в них, то раскомментируешь. Удалить всегда успеешь.

�� Удаляй все закомментированные свойства перед деплоем — публикацией проекта. Комментарии — утилитарная штука. Они полезны, но сильно загружают код и затрудняют его чтение. Если это не информационные комментарии, а следы экспериментов — удаляй их.

�� Иногда можно встретить в начале файла своеобразное оглавление, поясняющее в какой части файла искать стили для того или другого блока. Если у вас очень большой файл, то стоит попробовать такой подход. Он может оказаться удобным.

Алёна Батицкая советует

Скопировать ссылку «Алёна Батицкая советует» Скопировано

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

Строки комментариев (//) в CSS

CSS использует тот же синтаксис « блока комментариев », что и языки семейства C — вы начинаете комментарий с / * , и заканчиваете его * / .

Тем не менее, в CSS отсутствует правило синтаксиса « строка комментария », как в этих языках, где весь код от / / и до конца строки считается комментарием.

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

Поэтому, если мы добавим такой символ, и минимизатор удалит все разрывы строк (как он, как правило, и делает), то строка комментариев выведет в комментарии все стили, следующие за ней!

Тем не менее, CSS на самом деле уже позволяет использовать символ / / . Но он используется не для всей строки, а для последующей конструкции.

То есть, когда вы используете / / , последующая конструкции CSS — будь то объявление или блок — будет « выведена в комментарии ».

В этом коде объявление height выведено в комментарии.

//@keyframes foo < from, to < width: 500px; >50% < width: 400px; >> @keyframes bar < from, to < height: 500px; >50% < height: 400px; >>

Здесь через / / выведено в комментарии первое объявление @keyframes .

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

// Сделать какую-нибудь вещь. .foo < animation: bar 1s infinite; >/* Упс, блок .foo выпал в комментарии! */

Обновление: Упс, нашел ошибку у себя самого. К сожалению, синтаксис этого блока ( <> �� был некорректный.

Вы можете избежать этого, заканчивая текстовый комментарий символами <> (если вы не следуете правилам) или символом ; (если это объявление), чтобы дать CSS понять, что это просто шутка.

// Сделать что-нибудь <> .foo < animation: bar 1s infinite; >/* Теперь все правильно! */

Внимательный читатель может понять (или он просто знал это и раньше), что символ / / используется вовсе не для вставки комментариев.

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

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

Тем не менее, это все равно потенциально полезно для тех, кто не любит искать конец строки, чтобы закрыть комментарий символами * / , таких как я. ^ _ ^

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *