SITE BLOGGER
создание, продвижение сайтов
Комментарии в HTML, CSS, PHP
В данном уроке я расскажу о том, как делаются комментарии в HTML, CSS, PHP. Комментарии представляют собой текст, который не виден на веб-странице. Они используется для разного рода пояснений, напоминаний, описаний для вебмастеров, что позволяет структурировать документ. Комментарии незаменимы при отладке кода, позволяют быстро сориентироваться в разметке веб-страницы и найти нужный блок. Часто комментарии применяются для отладки кода HTML. К примеру, можно временно закомментировать конкретный блок кода, чтобы он не исполнялся, а в случае необходимости легко его восстановить.
Комментарии в HTML
Комментарии в CSS
Комментарии в CSS создаются с помощью символов: /* и */. Для создания комментария нужно просто поместить код-веб страницы между этими символами:
Комментарии в PHP
Комментарии в PHP могут быть однострочными и многострочными:
1) Однострочные комментарии в PHP создаются с помощью символов: //. Достаточно просто поставить этот символ перед строкой и она будет закомментирована.Такой вариант применятся в том случае, когда комментарий состоит только их одной строки.
2) Для реализации многострочных комментариев используются символы: /* и */. Такой вариант полезен, если комментарий занимает несколько строк.
Таким образом, мы научились делать комментарии в HTML, CSS, PHP. Благодаря комментариям мы всегда можем оперативно находить нужные блоки HTML кода и, при необходимости, изменять их структуру.
Комментарии в PHP
Комментирование кода PHP
Часто при написании кода разработчики делают какие-либо комментарии в самом коде, которые никак не влияют на выполнение скрипта, а только поясняют его. Комментирование важно при создании больших проектов и в случаях, когда группа разработчиков работает над одной программой.
Виды комментариев в PHP
В коде любой программы гораздо проще разобраться если в нём присутствуют комментарии. Кроме того, когда задача решается по частям, недоделанные участки кода также следует комментировать, чтобы не забыть о них в дальнейшем.
В коде PHP можно использовать несколько видов комментариев: в стиле языков Cи, C++ и оболочки Unix. Символы // и # обозначают начало однострочных комментариев, /* и */ – соответственно начало и конец многострочных комментариев.
Многострочные комментарии удобны, когда примечания, которые вам нужно вставить в код, не помещаются на одной строке. Возможность отмечать целые блоки из строк в качестве комментариев позволяет избежать применения однострочного комментария в начале каждой строки блока.
Пример
Ещё одно полезное применение многострочных комментариев — это временное отключение целых блоков кода PHP. Очень часто при написании PHP-скрипта возникает необходимость переписать его и сделать более эффективным. В этой ситуации можно закомментировать старый фрагмент кода, чтобы он программно не выполнялся, и написать новый код. Если окажется, что после запуска программы новый код хуже, чем закомментированный фрагмент, то можно удалить новый код и раскомментировать старый, чтобы вернуть его в поток выполнения.
Во время написания скриптов на PHP периодически требуется для целей отладки или для указания комментария, отмечать некоторые строки как комментарии. В языке программирования PHP имеется 2 вида таких комментариев:
Однострочный комментарий в PHP.
Однострочный комментарий в PHP применяется:
Любой текст, код который находится за последовательностью символов // будет проигнорировано интерпретатором PHP и не будет обрабатываться.
В результате работы кода выше будет выведена, например такая строка:
Многострочный комментарий
В случае, когда комментарием одной строкой не обойтись, то следует использовать многострочный комментарий. Его синтаксис следующий:
Любой текст или код, который будет заключен, между симовалами /* и */ воспринимается как комментарий и не будет обработан.
Гораздо чаще многострочный комментарий будет выглядеть, как:
Также многострочный комментарий может быть записан в одну строку:
Наиболее часто в профессиональной разработке на PHP вы будете встречать и использовать сами, многострочные комментарии в стиле PHPDoc (для чего такие комментарии используются, подробнее будет в отдельной статье):
Как можете обратить внимание, что в примере кода выше, такой специальный многострочный комментарий описывает тип входных аргументов (array), и тип возвращаемого значения (float или int) для функции getSum().
Будут ли видны Ваши комментарии в браузере?
Написанный вами PHP код выполняется только на сервере, и результат работы любого скрипта PHP этот текст, который уже отдается в браузер. В случае ВЕБ программирования результатом работы PHP скриптов, как правило является сгенерированыый HTML документ с тегами. И самое главное, что интерпретатор php, выполняя скрипт, игнорирует все строки заключенные в символы комментариев.
А значит ни одна строчка или строчки вашего кода, отмеченные как комментарии, никогда не будут обработаны, а их содержимое никогда не будет доступно в браузере у конечного пользователя.
Резюмируем.
При написании кода на языке программирования PHP принято использовать однострочные комментарии (//………) и многострочные комментарии (/* ………………… */).
Изучаем комментарии в PHP
Комментарии в PHP при выполнении скрипта игнорируются препроцессором, и нужны только для людей. Разработчики часто пренебрегают комментированием кода.
Среди программистов бытует мнение, что они вспомнят, как работает код, и через шесть месяцев и через год. Еще одна причина не оставлять комментарии — уверенность в том, что код настолько хорошо написан, что он ясен и без пояснений. Но нужно помнить, что может потребоваться продолжать поддерживать созданные скрипты PHP долгое время после написания.
Не менее важная причина комментирования кода — убедиться, что последователи поддерживают или добавляют функциональность вашему творению. Они также получат пользу от чтения оставленных комментариев.
Однострочные комментарии в PHP
Перед комментариями, которые находятся на одной строке, в PHP ставятся два символа косой черты ( // ).
Следующий пример содержит однострочный PHP комментарий в коде:
Однострочный комментарий может находиться на отдельной строке, или добавляется в конец строки кода:
Однострочные комментарии также применяются, чтобы временно убрать строки кода из потока выполнения. Например, следующее изменение предыдущего примера приведет к тому, что PHP проигнорирует всю команду echo во время выполнения:
Многострочные комментарии в PHP
Многострочные комментарии для сайта PHP обернуты разделителями / * и * /. Знак /* обозначает начало блока комментариев, а */ указывает на его конец. Следующий пример демонстрирует использование многострочного комментирования:
Многострочные комментарии полезны, когда заметки, которые вы хотите вставить в код, занимают более одной строки. Возможность помечать блоки строк как комментарии позволяет избежать использования однострочного комментария в начале каждой строки.
Итоги
Пожалуйста, оставьте ваши мнения по текущей теме статьи. Мы очень благодарим вас за ваши комментарии, отклики, лайки, дизлайки, подписки!
Дайте знать, что вы думаете по данной теме в комментариях. За комментарии, лайки, дизлайки, отклики, подписки низкий вам поклон!
Заголовок вверху выведет ‘Это пример’.
User Contributed Notes 11 notes
Notes can come in all sorts of shapes and sizes. They vary, and their uses are completely up to the person writing the code. However, I try to keep things consistent in my code that way it’s easy for the next person to read. So something like this might help.
/* Title Here Notice the First Letters are Capitalized */
# Option 1
# Option 2
# Option 3
/*
* This is a detailed explanation
* of something that should require
* several paragraphs of information.
*/
// This is a single line quote.
?>
It is worth mentioning that, HTML comments have no meaning in PHP parser. So,
WILL execute some_function() and echo result inside HTML comment.
Comments in PHP can be used for several purposes, a very interesting one being that you can generate API documentation directly from them by using PHPDocumentor (http://www.phpdoc.org/).
Therefor one has to use a JavaDoc-like comment syntax (conforms to the DocBook DTD), example:
/**
* The second * here opens the DocBook commentblock, which could later on
* in your development cycle save you a lot of time by preventing you having to rewrite
* major documentation parts to generate some usable form of documentation.
*/
?>
Some basic html-like formatting is supported with this (ie
tags) to create something of a layout.
Actually, both are correct. Once a comment is opened, *everything* is ignored until the end of the comment (or the end of the php block) is reached.
Thus, if a comment is opened with:
// then /* and */ are «overridden» until after end-of-line
/* then // is «overridden» until after */
Be careful when commenting out regular expressions.
E.g. the following causes a parser error.
I do prefer using # as regexp delimiter anyway so it won’t hurt me 😉
In php there are 3 types of comments
1.single line c++ style comment(//)
2.single line Unix shell stype comment(#)
3.multi line c style comment(/*/)
single or multi line comment comes to the end of the line or come first to the current block of php code.
HTML code will be printed after //. > or #. >
closing tag breaks the php mode and return to html mode.
The header above will break php mode and return html mode and show ‘Standard tag:single line c++ style comment’
The header above will break php mode and return html mode and show ‘Standard tag:single line unix shell style comment’
The header above will break php mode and return html mode and show ‘Standard tag:multi line c style comment’
The header above will break php mode show a unexpected syntex error’
The header above will break php mode show a unexpected syntex error’
The header above will break php mode show a unexpected syntex error’
Short tag: single line c++ style comment
The header above will break php mode and return html mode and show ‘Short tag:single line c++ style comment’
Short tag: single line unix shell style comment
The header above will break php mode and return html mode and show ‘Short tag:single line unix shell style comment’
Short tag: multi line c style comment
The header above will break php mode and return html mode and show ‘Short tag:multi line c style comment’
Script tag: single line c++ style comment
The header above will break php mode and return html mode and show ‘Script tag:single line c++ style comment’
Script tag: multi line c style comment
The header above will break php mode and return html mode and show ‘Script tag:multi line c style comment’
Script tag: single line unix shell style comment
The header above will not break php mode
Comments do NOT take up processing power.
So, for all the people who argue that comments are undesired because they take up processing power now have no reason to comment 😉
// Control
echo microtime (), «
» ; // 0.25163600 1292450508
echo microtime (), «
» ; // 0.25186000 1292450508
?>
They take up about the same amount of time (about meaning on a repeated testing, sometimes the difference between the control and the test was negative and sometimes positive).
a trick I have used in all languages to temporarily block out large sections (usually for test/debug/new-feature purposes), is to set (or define) a var at the top, and use that to conditionally comment the blocks; an added benefit over if(0) (samuli’s comment from nov’05) is that u can have several versions or tests running at once, and u dont require cleanup later if u want to keep the blocks in: just reset the var.
personally, I use this more to conditionally include code for new feature testing, than to block it out. but hey, to each their own 🙂
this is also the only safe way I know of to easily nest comments in any language, and great for multi-file use, if the conditional variables are placed in an include 🙂
for example, placed at top of file:
and then deeper inside the file: