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

18.4K

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

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

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

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

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

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

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

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

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

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

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

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

Данная публикация представляет собой перевод статьи «How to Insert a CSS Comment» , подготовленной дружной командой проекта Интернет-технологии.ру

www.internet-technologies.ru

Комментарии в CSS коде. Основы CSS для начинающих. Урок №4

Комментарии в CSS коде. Основы CSS для начинающих. Урок №4

Всем привет!
В этом уроке я расскажу, как в CSS коде оставить маленькую подсказку для себя или для других веб-мастеров, которые будут продолжать работу с вашим кодом. Но это не все, о чем бы мне хотелось рассказать.
Что же я называю подсказкой? Подсказка – это комментарий в коде, оставленный для того, чтобы вы или будущий веб мастер видели, какую работу было сделано в данной части кода. А еще можно временно выключить css стиль, не удаляя при этом css правила, и это будет называться «закомментировать код». Вот в этом уроке я и расскажу, как оставить в коде комментарий и как закомментировать код.

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

Выше я объяснил, для чего комментарии в коде, и, надеюсь, вы поняли, что в дальнейшем это поможет вам экономить свое время и время других.
Чтобы оставить комментарий в коде, достаточно прописать вот так:

/* здесь будет комментарий к коду  */

/* — открываем
*/ — закрываем

Пример:


/* Для заголовка */
h3
{
font-size: 150px; /* Размер шрифта */
color: #cc0000 /* Цвет текста */
}

Эти подсказки на веб-странице отображаться визуально не будут, только в коде.

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

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

/* здесь код  */

Пример:


h3
{
/*
font-size: 150px;
color: #cc0000;
*/
}

Можно и так:


h3
{
/*font-size: 150px; Размер шрифта */
/*color: #cc0000 Цвет текста */
}

Можно и так:


/*
h3
{
font-size: 150px; Размер шрифта
color: #cc0000 Цвет текста
}
*/

Я частенько люблю так делать:

Как оставить комментарий и как закомментировать код, разобрались. Двигаемся дальше.

Жду вас на следующих уроках. 

Предыдущая запись
Как подключить CSS — способы подключения. Основы CSS для начинающих. Урок №3
Следующая запись
Оформление текста в CSS. Основы CSS для начинающих. Урок №5

stepkinblog.ru

Комментарии — Веб-технологии для разработчиков

Описание

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

Синтаксис

/* Комментарий */

Примеры

/* Однострочный комментарий */

/*
Комментарий
который содержит
несколько
строк
*/

Замечания

Данный /* */ синтаксис комментария используется для обоих вариантов, и однострочного и многострочного комментария. Нет других способов добавить комментарий во внешнюю таблицу стилей. Также, когда используется элемент <style>, вы можете использовать <!— —>, чтобы спрятать CSS от старых браузеров, но это не рекомендуется. Как и в большинстве языков программирования, которые используют синтаксис комментариев /* */ , комментарии нельзя вкладывать друг в друга. Другими словами, данная часть синтаксиса */, которая следует за /* закрывает комментарий.

Спецификации

Смотрите также

  • Руководство по CSS
  • Ключевые концепции CSS:
    Синтаксис CSS,
    @-правила,
    комментарии,
    специфичность и
    наследование,
    блочная модель,
    режимы компоновки и
    модели визуального форматирования,
    схлопывание отступов,
    начальные,
    вычисленные,
    решённые,
    указанные,
    используемые и
    действительные значения.
    Синтаксис определения значений,
    сокращённые свойства и
    замещаемые элементы.

Метки документа и участники

Обновлялась последний раз:
mdnwebdocs-bot,

developer.mozilla.org

Как закомментировать код CSS, HTML, JavaScript или PHP

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

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

/* Закомментированный код */

Примеры:

Комментировать код в HTML

<!— Закомментированный код —>

Примеры:

Комментировать код в JavaScript

// Закомментированный код

/* Закомментированный код */

Примеры:

Комментировать код в PHP

// Закомментированный код

/* Закомментированный код */

Примеры:

Надо отметить, что двойной слеш // комментирует только строку.

Если использовать специальный редактор Notepad ++, тогда закомментированный код окрасится в зеленый цвет. Это очень удобно!

На заметку: JavaScript — независимый язык программирования, со своей спецификацией ECMAScript, и к Java не имеет никакого отношения.

Всем удачи и добра!

epicblog.net

Базовый синтаксис CSS | htmlbook.ru

Как уже было отмечено ранее, стилевые правила записываются в своём формате, отличном от HTML. Основным понятием выступает селектор — это некоторое имя стиля, для которого добавляются параметры форматирования. В качестве селектора выступают теги, классы и идентификаторы. Общий способ записи имеет следующий вид.

Вначале пишется имя селектора, например, TABLE, это означает, что все стилевые параметры будут применяться к тегу <table>, затем идут фигурные скобки, в которых записывается стилевое свойство, а его значение указывается после двоеточия. Стилевые свойства разделяются между собой точкой с запятой, в конце этот символ можно опустить.

CSS не чувствителен к регистру, переносу строк, пробелам и символам табуляции, поэтому форма записи зависит от желания разработчика. Так, в примере 5.1 показаны две разновидности оформления селекторов и их правил.

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

HTML5CSS 2.1IECrOpSaFx

<!DOCTYPE HTML>
<html>
 <head>
  <meta charset="utf-8">
  <title>Заголовки</title>
  <style> 
   h2 { color: #a6780a; font-weight: normal; } 
   h3 { 
    color: olive; 
    border-bottom: 2px solid black; 
   }
  </style>
 </head>
 <body>
  
  <h2>Заголовок 1</h2>
  <h3>Заголовок 2</h3>
  
 </body>
</html>

В данном примере свойства селектора h2 записаны в одну строку, а для селектора h3 каждое свойство находится на отдельной строке. Во втором случае легче отыскивать нужные свойства и править их по необходимости, но при этом незначительно возрастает объем данных за счёт активного использования пробелов и переносов строк. Так что в любом случае способ оформления стилевых параметров зависит от разработчика.

Правила применения стилей

Далее приведены некоторые правила, которые необходимо знать при описании стиля.

Форма записи

Для селектора допускается добавлять каждое стилевое свойство и его значение по отдельности, как это показано в примере 5.2.

Пример 5.2. Расширенная форма записи

td { background: olive; }
td { color: white; }
td { border: 1px solid black; }

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

Пример 5.3. Компактная форма записи

td {
  background: olive;
  color: white;
  border: 1px solid black;
}

Эта форма записи более наглядная и удобная в использовании.

Имеет приоритет значение, указанное в коде ниже

Если для селектора вначале задаётся свойство с одним значением, а затем то же свойство, но уже с другим значением, то применяться будет то значение, которое в коде установлено ниже (пример 5.4).

Пример 5.4. Разные значения у одного свойства

p { color: green; }
p { color: red; }

В данном примере для селектора p цвет текста вначале установлен зелёным, а затем красным. Поскольку значение red расположено ниже, то оно в итоге и будет применяться к тексту.

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

Значения

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

Комментарии

Комментарии нужны, чтобы делать пояснения по поводу использования того или иного стилевого свойства, выделять разделы или писать свои заметки. Комментарии позволяют легко вспоминать логику и структуру селекторов, и повышают разборчивость кода. Вместе с тем, добавление текста увеличивает объём документов, что отрицательно сказывается на времени их загрузки. Поэтому комментарии обычно применяют в отладочных или учебных целях, а при выкладывании сайта в сеть их стирают.

Чтобы пометить, что текст является комментарием, применяют следующую конструкцию (пример 5.5).

Пример 5.5. Комментарии в CSS-файле

/* 
  Стиль для сайта htmlbook.ru
  Сделан для ознакомительных целей
*/
  
div {
  width: 200px; /* Ширина блока */
  margin: 10px; /* Поля  вокруг элемента */
  float: left; /* Обтекание по правому краю */
}

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

Вопросы для проверки

1. Люба подключила к HTML-документу одновременно два стилевых файла — style1.css и style2.css. Причём в файле style2.css первой строкой импортируется еще один файл с именем style3.css. В файле style1.css цвет текста задается красным, в style2.css — синим, а в style3.css — зелёным. Какой цвет текста будет на странице?

  1. красный.
  2. синий.
  3. зелёный.
  4. чёрный.
  5. установленный в браузере по умолчанию.

2. В какой строке кода содержится ошибка?

  1. p { text-align: center; color: #000000 }
  2. div { color: red; font-size: 11pt; }
  3. title { color: #fc0; margin: 10px; }
  4. p { color: green; color; }
  5. html {
    float: left; }

3. Какая ошибка содержится в следующем коде?

/* ———————————
div {
color: #fc0; /* Цвет теска */
margin: 10px; /* Поля вокруг элемента */
float: left /* Обтекание по правому краю */
}
——————————— */

  1. Опечатка в тексте комментария.
  2. Вложенные комментарии.
  3. Нет точки с запятой.
  4. Недопустимые значения у стилевых свойств.
  5. Лишние переносы в коде.

4. В какой строке содержится корректный синтаксис?

  1. body:color=black
  2. body{color:black}
  3. {body;color:black}
  4. {body:color=black}
  5. body{color=black}

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

  1. ‘ комментарий
  2. // комментарий
  3. // комментарий //
  4. /* комментарий */
  5. <!— комментарий —>

Ответы

1. синий.

2. p { color: green; color; }

3. Вложенные комментарии.

4. body{color:black}

5. /* комментарий */

htmlbook.ru

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

5.6K

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

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

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

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

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

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

Например:

.foo {
  width: auto;
  //height: 500px;
  background: green;
}

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

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

Данная публикация представляет собой перевод статьи «Single Line Comments (//) in CSS» , подготовленной дружной командой проекта Интернет-технологии.ру

www.internet-technologies.ru

seodon.ru | Учебник CSS — Комментарии в CSS

Опубликовано: 14.11.2010 Последняя правка: 08.12.2015

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

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

Старайтесь во внешних таблицах стилей указывать комментарии только на латинице. Дело в том, что некоторые старые браузеры порой впадают в ступор при виде комментариев на русском языке, в частности этим грешит Internet Explorer 6.0. Но естественно в примерах этого учебника я буду писать их на русском.

Пример создания комментариев в CSS

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <title>Создание комментариев</title>
  <style type="text/css">
   p {
    color: red; /* цвет текста параграфов */
 /* background: blue; фоновый цвет */
   }
  </style>
 </head>
 <body>
  <p>Параграф.</p>
 </body>
</html>

Результат в браузере

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

Пример скрытия CSS от старых браузеров

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
 <head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <title>Создание комментариев для скрытия CSS</title>
  <style type="text/css">
   <!--
   p {
    color: red; /* цвет текста параграфов */
    background: blue; /* фоновый цвет */
   }
   -->
  </style>
 </head>
 <body>
  <p>Параграф.</p>
 </body>
</html>

Результат в браузере

seodon.ru

Отправить ответ

avatar
  Подписаться  
Уведомление о