Коментарі CSS: правила використання

Коментарі CSS: правила використання

Використання коментарів у коді завжди вважалося хорошим тоном серед програмістів. Це полегшує сприйняття коду, допомагає розділити його на логічні блоки і особливо допомагає у спільній роботі над будь-яким проектом. Розгляньмо, як правильно використовувати коментарі в CSS.

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


Ми розповімо, яким чином грамотно прокоментувати ваш код.

Синтаксис коментарів

Для того, щоб браузер не сприймав інформацію з блоку з коментарем, а тільки відображав дані, використовується наступний синтаксис:

.block {
  color: #000000;
  text-decoration: underline; /*этот текст будет подчеркнутым*/
  font-style: italic;
}

Тобто текст полягає в конструкції/*... */. Переглядач не сприйматиме коментарів у CSS як елементи, які слід виконувати. Вони можуть розташовуватися в будь-якому місці документа.

Дуже часто CSS-код в ході роботи над проектом стає довгим, з великою кількістю різноманітних блоків - один, наприклад, описує шапку сайту, наступний - поля введення тексту і так далі. Для того, щоб акуратно виділити кожен з таких блоків, також можна використовувати коментар. Багато розробників роблять це так наступним чином.

/* ------------------Это левая часть------------------*/
#left {
  background: red;
  width: 20%;
  height: 100%;
}
/* ------------------Это правая часть------------------*/
#right {
  background: green;
  width: 80%;
  height: 100%;
}


Тобто сам коментар виділяється за допомогою дефісів, щоб візуально виділити ту частину роботи, яку потрібно відзначити.

Правила створення та використання коментарів

Коментар в CSS може бути як багатостроковим, так і одностроковим, це не регламентовано. Важливо лише те, що вказано між відкриваючим і закриваючим тегом.

Іноді потрібно вимкнути якийсь уривок коду, щоб перевірити, яким чином форматування буде відображатися в браузері без нього. Досить незручно кожен раз копіювати його в новий документ, є ризик втратити його з буфера обміну - в такому випадку найпростіше укласти його в синтаксис коментаря.

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

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

Коментування використовується в наступних випадках:

  1. Для зручності розуміння коду його автором. Коли потрібно внести правки в роботу, набагато легше знайти блок, коли він забезпечений пояснюючим підписом.
  2. У командній роботі над проектом, коли потрібно вказати колегам на ту чи іншу інформацію в тілі документа.
  3. Для логічного поділу коду на певні блоки, що також суттєво спрощує роботу.
  4. У коментарі можна додати допоміжні уривки коду, які потрібно перестати відображати в певний момент.
  5. Як правило, на початку коду C SS у формі коментарів вказується інформація про розробника та інші інформаційно-технічні дані, такі як назва проекту, ім 'я автора, дата створення та інші.

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