Как оформлять комментарии в html, css, php коде

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

Для чего нужны комментарии в исходном коде программ

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

Как оформлять комментарии на разных в HTML, CSS и PHP коде

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

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

Создать комментарий внутри HTML – очень легко. За это в данном языке разметки отвечает тег . Вместо "blah-b…" может быть написано абсолютно все, что угодно на любом языке (но лучше, конечно, использовать английский – так принято в программировании). Очень важный нюанс: двойной дефис ("--") внутри HTML-комментария воспринимается любым браузером, как завершение "". Это, в свою очередь, приводит к ошибке (в случае с HTML – выводу фрагмента комментария). Поэтому при создании разметки страниц следует избегать такого вида текста: "". Вместо этого лучше написать "".

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

В CSS используется другой стиль написания комментариев. Он выглядит следующим образом: /* пример комментария */. Все, что находится внутри двух символов (слеша и звездочки) игнорируется браузером. Такие комментарии являются многострочными. То есть интерпретатор будет игнорировать все написанное до той поры, пока не встретит "*/". Если требуется закомментировать какой-то параметр внутри CSS-кода, то необязательно использовать достаточно громоздкий вид комментариев, указанный выше. Можно просто поставить вначале строки какой-нибудь символ, например, тильду (~).

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

При написании скриптов на PHP можно пользоваться тремя стилями комментариев. Первый из них такой же, как в CSS: /* текст */, и он тоже является многострочным. Если требуется нужно закомментировать только одну строку, то можно использовать два слеша: //.

Также в этом языке реализован Unix-подобный стиль: # (решетка). Все, что присутствует на линии после соответствующих одного из указанных знаков игнорируется при исполнении кода. Важно: в PHP нельзя допускать вложенных комментариев: /* … /* … */ … */. Также при размещении скрипта в HTML-коде комментарии, предназначенные для PHP, нужно писать в блоке с соответствующими инструкциями, то есть после "".

Сергей Мазураш aka Retliff Блоггер со стажем. Стиль публикаций отличается простотой изложения и весёлым, ироничным подходом к самым серьёзным проблемам. Cпециализируется на создании и продвижении бесплатных блогов на платформе Blogger.

Твитнуть