Как правильно комментировать на css

HTML-комментарии

Это задание архивной части. Перейдите по ссылке, чтобы пройти актуальную часть.

Комментарий в HTML-коде задаётся так:

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

• Для комментирования кода. Всегда полезно оставить подсказку.
• Для временного отключения кода. Удалять код неудобно, так как его надо будет восстанавливать, а закомментировать и потом раскомментировать — самое лучшее решение.

Комментарии можно использовать в любом месте страницы, кроме тега — внутри него они не работают. Внутри тега HTML-комментарии тоже не работают, так как в CSS код комментируется другим способом, о котором вы узнаете в части «Знакомство с CSS».

Чтобы быстро закомментировать или раскомментировать строку кода в HTML или CSS редакторе, можете использовать сочетание клавиш ctrl + / или cmd + / .

Перейти к заданию

• index.html Сплит-режим
• style.css Сплит-режим

Строки комментариев (//) в 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 четко определяет, как взаимодействовать с браузерами, реализующими код, чтобы обеспечивать работу без сбоев.

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

Комментарии в 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. Допустим, вы хотите временно отключить какие-то стили, но удалять код не хотите. Для этого можно воспользоваться специальным кодом для комментирования:

То есть, мы можем комментировать код с помощью открывающих символов /* и закрывающих */.

Причем комментировать можно не только код, но и любой текст. Например:

/* Заголовки */ h1 < color: red; font-size: 32px; text-align: center; /* выравниваем по центру блока */ >

Статья была полезной?
Рекомендуем к прочтению
�� Комментарии:

Отменить ответ

✏️ Наши авторы
Публикаций: 12
ID; echo $user->display_name; the_author_image($user->ID); echo $user->description; —>
Кирилл Черепахин
Публикаций: 13
ID; echo $user->display_name; the_author_image($user->ID); echo $user->description; —>
Владимир Самойлов
Публикаций: 210
ID; echo $user->display_name; the_author_image($user->ID); echo $user->description; —>
Публикаций: 168
ID; echo $user->display_name; the_author_image($user->ID); echo $user->description; —>
CSS Головоломки в Telegram
Подписывайся и не пропускай:
Актуальные новости
Интересные задачки
Полезные подборки
Вступай в клуб
��‍�� Присоединяйся к сообществу!
Наш рейтинг
�� Лучшие биржи ссылок
GoGetLinks
Наш рейтинг
�� Лучший хостинг для сайта
Где учиться
��‍�� Рекомендуемые курсы
Javascript-разработчик
Введение в программирование
SEO-специалист
Проверка знаний
�� Хорошо ли вы знаете CSS?

Есть два блочных элемента, которые идут друг за другом в html. Какой будет оступ (margin) между ними, если задать им такие стили:

 .top < height: 30px; background-color: blue; margin-bottom: 10px; >.bottom

Больше интересных задачек по CSS в нашем Telegram канале ��
Peach Fuzz
�� Цвет 2024 года

Исследовательский институт Pantone выбрал главный цвет 2024 года. Им стал нежный бархатистый персиковый оттенок, получивший название Peach Fuzz (Персиковый пух).

Ресурс WEB Головоломки создан для того, чтобы делиться накопленным опытом и знаниями. Мы надеемся, что наши статьи будут полезны новичкам — тем, которые только решили вникнуть в мир web-разработки.
На сайте вы найдете публикации по разным направлениям и темам: tilda, wordpress, верстка, seo-продвижение.

• О проекте
• Все записи
• Новости партнеров
• Тест по CSS
• Контакты
• Важность мета-тегов при продвижении сайта в Google
• Где купить ссылки для сайта