Как правильно вставляются комментарии в css код

Как правильно вставляются комментарии в css код

Тег добавляет комментарий в код документа. Текст комментария не отображается на странице. Разрешается внутрь комментария добавлять другие теги, вложенные комментарии (когда один комментарий расположен внутри другого) недопустимы.

Синтаксис

Атрибуты

Пример 1. Использование комментариев

HTML 4.01 IE Cr Op Sa Fx

      
Меню
 
Содержимое документа
  

Пример 2. Использование комментариев

HTML5 IE Cr Op Sa Fx

Примечание

Двойной дефис внутри комментария (—) воспринимается как часть комментария и соответственно его наличие приводит к ошибке при валидации документа.

Статьи по теме

Комментарии в 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 / .

На практике

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Как закомментировать CSS (и как писать комментарии)

Подпишись на наш телеграм-канал TechRocks WEB-разработка?

Комментарии — составляющая часть кода на любом языке программирования. Есть возможность комментирования и в CSS.

Если вы работаете в команде и занимаетесь большим проектом, вам нужна возможность как-то пояснять свой код товарищам. Тут вам на помощь придут комментарии.

Таблицы стилей со временем могут стать очень сложными и объемными. Поэтому систематическое добавление комментариев должно стать общепринятой практикой в команде.

В этой статье мы рассмотрим, как добавлять встроенные и многострочные комментарии в CSS.

Как закомментировать CSS

Чтобы закомментировать часть CSS-кода, вам понадобится обычный слэш ( / ) и астериск ( * ).

Для добавления как встроенного, так и многострочного комментария в CSS вы начинаете со слэша и астериска ( /* ). Их же, но в обратном порядке ( */ ) вы ставите в конце комментария.

Вот как выглядит встроенный (строчный) комментарий в CSS:

/* This is an inline comment in CSS */

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

/* This is a multi-line comment in CSS */

Вы также можете закомментировать те строки CSS, которые не должны выполняться:

/* .email-sub < padding: 0.2rem; border: 1px solid var(--primary-color); border-radius: 4px; >.email-sub:focus < border: 1px solid var(--secondary-color); outline: none; >*/

С помощью комментариев обозначают начало и конец стилей отдельных разделов на веб-странице:

/* Hero section starts */ .hero < display: flex; align-items: center; justify-content: space-between; gap: 1.9rem; max-width: 1100px; margin: 2rem auto -6rem; >/* Hero section ends */

Комментарии помогут вам и тогда, когда вы хотите оставить примечание в вашем CSS для разработчиков, которые будут работать с вашим кодом после вас:

/* Don't override this style if you don't know what you are doing. Otherwise, CSS might give you a kick in the butt */

Организация CSS при помощи комментариев

Примечание редакции Techrocks: этот раздел взят из другой статьи — «CSS Comment Example – How To Comment Out CSS».

В более крупных проектах CSS-файлы могут быстро разрастись. В результате их может стать трудно поддерживать. Упорядочивание СSS и разделение кода на отдельные части поможет лучше ориентироваться в стилях в будущем. При этом стоит также создать «Содержание» документа:

/* * CSS TABLE OF CONTENTS * * 1.0 - Reset * 2.0 - Fonts * 3.0 - Globals * 4.0 - Color Palette * 5.0 - Header * 6.0 - Body * 6.1 - Sliders * 6.2 - Imagery * 7.0 - Footer */ /*** 1.0 - Reset ***/ /*** 2.0 - Fonts ***/ /*** 3.0 - Globals ***/ /*** 4.0 - Color Palette ***/ /*** 5.0 - Header ***/ /*** 6.0 - Body ***/ h2 < font-size: 1.2em; font-family: "Ubuntu", serif; text-transform: uppercase; >/*** 5.1 - Sliders ***/ /*** 5.2 - Imagery ***/ /*** 7.0 - Footer ***/

Заключение

В долгосрочной перспективе комментарии в СSS могут помочь вспомнить, что вы делали, когда писали тот или иной код.

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