Заголовки

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

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

Комментарии игнорируются браузерами.

CSS комментарий помещается внутри файла элемента , и начинается с /* и заканчивается */ :

Пример

Вы можете добавлять комментарии в любом месте кода:

Пример

Комментарии могут занимать несколько строк:

Пример

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

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

В следующем примере мы используем комбинацию комментариев HTML и CSS:

Пример

Мой заголовок

Привет Мир!

Этот параграф стилизован под CSS.

Комментарии CSS не отображаются в выходных данных.

Мы только что запустили
SchoolsW3 видео

Сообщить об ошибке

Если вы хотите сообщить об ошибке или внести предложение, не стесняйтесь отправлять на электронное письмо:

Ваше предложение:

Спасибо Вам за то, что помогаете!

Ваше сообщение было отправлено в SchoolsW3.

ТОП Учебники

ТОП Справочники

ТОП Примеры

SchoolsW3 оптимизирован для бесплатного обучения, проверки и подготовки знаний. Примеры в редакторе упрощают и улучшают чтение и базовое понимание. Учебники, ссылки, примеры постоянно пересматриваются, чтобы избежать ошибок, но не возможно гарантировать полную правильность всего содержания. Некоторые страницы сайта могут быть не переведены на РУССКИЙ язык, можно отправить страницу как ошибку, так же можете самостоятельно заняться переводом. Используя данный сайт, вы соглашаетесь прочитать и принять Условия к использованию, Cookies и политика конфиденциальности.

Источник

CSS GuideLines, часть 2. Комментирование кода

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

• Что какой-то кусок кода зависит от другого куска;
• Какой эффект повлечет за собой изменение определенной части кода;
• Где еще можно использовать кусок кода без появления новых проблем;
• Какие стили наследует определенный элемент;
• Какие стили могут быть проигнорированы;
• Где разработчик намеревался использовать код.

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

Как правило, следует комментировать те места кода, которые будут непонятны разработчику, если вырвать их из контекста. Нет необходимости делать пометку о том, что color: red; сделает текст красным. Но, например, если вы используете свойство overflow: hidden; для очистки float’ов, а не для скрытия контента за пределами блока, то вам следовало бы добавить пояснительный комментарий.

Высокоуровневые комментарии

Для больших комментариев, описывающих целую секцию или компонент, мы используем DocBlock-подобные мультистрочные комментарии, соответствующие нашему правилу о 80 символах в строке.

Ниже можно увидеть реальный пример комментирования кода шапки сайта CSSWizardy.

/** * The site’s main page-head can have two different states: * * 1) Regular page-head with no backgrounds or extra treatments; it just * contains the logo and nav. * 2) A masthead that has a fluid-height (becoming fixed after a certain point) * which has a large background image, and some supporting text. * * The regular page-head is incredibly simple, but the masthead version has some * slightly intermingled dependency with the wrapper that lives inside it. */ 

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

Указание на наследование стилей

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

Например, в файле с главным классами (объектами):

/** * Extend `.btn <>` in _components.buttons.scss. */ .btn <> 

В файле с дочерними классами:

/** * These rules extend `.btn <>` in _objects.buttons.scss. */ .btn--positive <> .btn--negative <> 

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

Низкоуровневые комментарии

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

Препроцессоры и комментирование

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

// Dimensions of the @2x image sprite: $sprite-width: 920px; $sprite-height: 212px; /** * 1. Default icon size is 16px. * 2. Squash down the retina sprite to display at the correct size. */ .sprite < width: 16px; /* [1] */ height: 16px; /* [1] */ background-image: url(/img/sprites/main.png); background-size: ($sprite-width / 2 ) ($sprite-height / 2); /* [2] */ >

В этом примере мы задокументировали переменные (которые не будут скомпилированы) с помощью комментариев препроцессора, а для обычного кода мы применили стандартный способ комментирования. Такой способ гарантирует нам то, что в скомпилированных CSS-файлах будет только релевантная и нужная для нас информация.

Удаление комментариев

Следует сказать о том, что при использовании кода в продакшене все комментарии должны быть удалены, а сам 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 могут также включать в себя такую метаинформацию, как:

• Автор;
• дата создания;
• информация об авторских правах.

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

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

ВЛ Виктория Лебедева автор-переводчик статьи «

Источник

Базовый синтаксис CSS

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

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

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

HTML5 CSS 2.1 IE Cr Op Sa Fx

     h1 < color: #a6780a; font-weight: normal; >h2 
Заголовок 1
 
Заголовок 2
  

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

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

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

Форма записи

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

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

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

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

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

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

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

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

В данном примере для селектора 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. В какой строке кода содержится ошибка?

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

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

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

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

1. ‘ комментарий
2. // комментарий
3. // комментарий //
4. /* комментарий */

Ответы

Источник