Комментарии в HTML-, CSS-, JS- и PHP-коде

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

Сейчас я подробно покажу четыре типа комментариев, точнее, все их виды для четырех разных кодов.

Комментарии в HTML-разметке

Для того чтобы добавить комментарий в HTML-разметку, используем:

<!-- Текст, код или прочее -->

Все, что стоит в этих тегах, не видно на экране, но доступно для просмотра в исходном коде.

Комментарии в CSS-стилях

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

/* Текст, код или прочее */ 

Все, что стоит в этих тегах, не учитывается при формировании стилей, но доступно для просмотра в самом файле стилей.

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

Для добавления комментариев в JavaScript существуют два их типа.

Первый тип:

// Текст, код или прочее

Второй тип:

/* Текст, код или прочее */ 

Все, что стоит в этих тегах, не учитывается при выполнении скрипта, но доступно для просмотра в самом файле JavaScript.

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

Этот язык программирования, в отличие от предыдущих, имеет 3 типа комментариев.

Первый тип:

// Текст, код или прочее 

Второй тип:

/* Текст, код или прочее */

И третий тип:

# Текст, код или прочее

Все, что стоит в этих тегах, не учитывается при выполнении скрипта и видно только в самом файле PHP.

Обратите внимание!

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

/* /* Мой код */ */ 

выведет вам ошибку.

2. Комментарии, которые пишутся через /* */ и <!-- -->, могут писаться в несколько строк:

/* 
Это 
Мой 
Код 
*/ 

В остальных же случаях для каждой строки нужно писать специальный символ комментария, например:

// Это 
// Мой 
// Код 

В противном случае вы также обнаружите ошибку.