25.04.2017

Всем привет!
Продолжаем изучать основы PHP с нуля!
В этом уроке я расскажу, что такое комментарий в PHP и на практике попробуем прописать в коде свой комментарий. Но это еще не все. Еще хочу рассказать, как закомментировать код и для чего это вообще нужно делать.

Что такое комментарий в PHP
Комментарий в PHP – это подсказка php-разработчика для быстрого ориентирования в коде, а также для правок.

Комментарий в PHP невиден для пользователя, который открыл веб-страницу для просмотра. Даже если пользователь надумается посмотреть исходный код страницы, комментарий все равно виден не будет, так как и весь код php.

PHP комментарий коде

Существует 2 вида комментариев для кода PHP:

→ однострочный
→ многострочный

⇒ Однострочный комментарий для PHP
Для однострочного комментария следует применять символы «// » или «# »

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

Подпишись на обновление"; # подписка (это комментарий) ?>

Подпишись на обновление

⇒ Многострочный комментарий для PHP
Многострочный комментарий для PHP начинается с символа «/* » и заканчивается символом «*/ ».
Все, что находится между этими символами, будет игнорироваться и считаться как комментарий.
Многострочный комментарий используется, если в записи несколько строк.

На экране вы только увидите вот такой текст:

Привет читателям блога - сайт!!!

P.S.: Всегда комментируйте свой код. Если вы считаете, что вспомните все, что делали в коде через 1-2 года, вы ошибаетесь, шанс очень маленький. Даже если и вспомните, то придется потратить кучу времени на изучение – что, куда и зачем…
Сделайте приятное для себя будущего – закомментируй код и ты сам себе потом скажешь «СПАСИБО!!!».
Оставь комментарий в коде, это займет 1 минуту времени, но сэкономит тебе в будущем целый день.

Закомментировать PHP код

Припустим, вы написали php код, но по каким-то причинам вам нужно удалить из кода 2 строки.
Я не спешу удалять что-то из кода, особенно, если это php-код, я лучше его закомментирую. А вдруг нужно будет код вернуть. Легче же разкомментировать, чем по-новому писать код.

Как закомментировать код в PHP
Пример с однострочным комментарием:

Подпишись на обновление"; ?>

Пример с многострочным комментарием.

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

Вы зашли по адресу… но несколько слов для ясности и пользы дела. Наверняка видели, как это делается с CSS-кодом , так как сss представляет наибольший интерес у многих начинающих, как и я.

… Хорошо!

Но обратите внимание, что комментарии используются также и в html и php … А ведь большинство начинающих путаются на начальном этапе своей работе с сайтом и не знают, как дописать себе необходимые пояснения. Ведь бывает же так, например, вам потребуется на какое-то время деактивировать код html , а потом снова возобновить его функцию — это запросто реализовать, если вы сделали себе пометки на «полях», да мало ли что.

Но что следует помнить о «комментариях» вообще — тут всё в строгой зависимости от того, с каким файлом вы работаете конкретно, а следовательно и код применения различен.

Комментируем код CSS

a:hover, a:focus { color: #D5071E; text-decoration: Overline; /*ПОДЧЁРКИВАНИЕ ВВЕРХУ*/ }

Таким образом вы делаете себе пояснение. Или можно вообще закомментировать этот скрипт css так: просто оберните

/* здесь КОД */

/*a:hover, a:focus { color: #D5071E; text-decoration: underline; /*ПОДЧЁРКИВАНИЕ ВНИЗУ*/ }*/

Обращаю ваше внимание на то, что — закомментировать полный цикл кода css таким способом можно, но!! тогда придётся убрать повторные комментарии /*ПОДЧЁРКИВАНИЕ ВНИЗУ*/ , или поиграть слэшами, если пояснение важно))

Иначе будет ошибка!!

Ко сведению:

Если открыть исходный код страницы — Ctrl+U и взглянуть… то увидим, что закомментированный кусок кода css замечательно отображается в сгенерированном документе! это если css использовалось (задавались свойства) прямо в html

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

Английское наречие (слова) будут читаемы. Русская символика — нет.

Комментируем код HTML

Аналогично комментируется и файл XML

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

Обычная невнимательность при форматировании может стоить времени, например, показанный выше ЗАКОММЕНТИРОВАННЫЙ код частенько бывает ошибочен: заместо двух коротких дефисов вырисовывается длинное тире:

К сведению же:

как говорилось в предыдущей ремарке — так же и закомментный… код html отображается в сгенерированном документе!

Имейте в виду это.

И вот ещё что:

помимо того, что комментированный код отображается в исходном коде страницы (а значит и отрабатывается в каком-то смысле, хотя и на страничке будет невидим!) — какие-то функции php связкой с html лучше выносить из активного документа.

Например:

будет виден в документе и функция замечательно отработает своё дело: т.е во фронтенде информации станет не видать, но вот в исходнике — она чётко отобразится! и это беспонтовый запрос к БД: всё это мелочь, но знать надобно!

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

добавьте перед необходимым «лишним» html кодом открывающий … встроенная функция… и закрывающий?> …

Словом, вот так можно поступить, если код большой:

**/ ?>

тогда исходник будет чистеньким!

Или попроще:

Закомментируем саму функцию в документе html . Исходник в этих случаях относительно отработок функций будет чистеньким!

как закомментировать JavaScript

if (beingShown || shown) { // don"t trigger the animation again return; } else { // в строке применяем ЛЮБОЙ КОММЕНТАРИЙ // в строке применяем ЛЮБОЙ КОММЕНТАРИЙ // true;

Этот пример-код JavaScript, - я, для наглядности, ухватил в нете, слегка поправив пунктуацию. Это неважно… Главное понять принцип…

Как вы понимаете слеш «// » двойной, это и есть ЗНАК комментария… ОДНОСТРОЧНЫЙ!

А в остальном код JS комментируется подобно php , об этом ниже:

ремарка:

Комментируем код PHP

…и …здесь аналогично – слеш-слеш… однострочный.

Но обратите внимание, что его можно комментировать так, как и код-CSS.

…либо так можно закомментировать — однострочный вариант, когда используем НЕ ДВА СЛЕШ, но БЕКАР (решётка) перед комментируемой строкой:

…Естественно, комментировать нужно осторожно в цикле кода!

…либо же таким образом — аналогично показанному выше примеру для CSS… т.е. этот /* код */ вариант комментирования подойдёт и для CSS и для JS кодов!

А вот таким образом можно закомментировать более объёмное пояснение к коду PHP, где-то меж его основными примерами…

Ещё в циклах php можно комментровать и так, коли код смешанный… php и как-то html

Аналогично описанному выше:

К примеру какая-то такая функция… где-то в общем коде (или цикл в html): — можно закомментировать, т.е добавить свою метку так:

или так: однострочный вариант…

Сведения:

php код не виден ни в каких исходных кодах!! виден только его функциональный результат — отработка!

Вот в общем и всё что хотелось нынче доложить!

Теперь можете поэкспериментировать… Удачи.

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

...город веб мастеров Михалика.ru © - запросто с WordPress

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

Комментарии: плохие и хорошие

Возможность комментирования кода доступна на большинстве языков программирования (возможно, на всех, но с разной степенью доступности). Как правило, словесные разъяснения используются для того, чтобы помочь в дальнейшей разработке другим членами команды, или просто напомнить себе о том, что для этого участка нужны исправления (“FIX ME”).

Конечно, пояснение к написанному - это благо. Но при помощи комментариев можно и перечеркнуть все хорошие стороны кода. Чтобы этого не случилось, необходимо различать виды комментов:

документирующие. Хорошей ассоциацией станет понятие документации для различного программного обеспечения. Такие комментарии помогают в использовании кода, словно инструкция. Подобное комментирование не воспринимается лишним, ведь без него никак. Представьте, что кто-то использовал авторский фреймворк и не рассказывает, как пользоваться программой;

JavaScript. Быстрый старт

поясняющие. Хорошему коду они, как правило, не нужны. Чем больше строчек комментариев вы видите в программе, тем больше вероятность того, что программа написана плохо. Конечно, это не абсолютное правило.

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

Иногда подобное чувство одолевает и профессионалов. К примеру, когда все выглядит удивительно криво - должно же быть решение получше. Чтобы уберечь последователей от поиска лучшего, программист может оставить такую записку: #time_spent_here=24h

После таких слов мало кто захочет тратить столько времени. Таким образом, вы предупреждаете, что множество разных вариантов уже перебрали. В то же время, стоит избегать таких выпадов: #i_hate_this, #try_to_do_better_ass%%le. Подобным образом вы проявляете лишь непрофессиональное отношение. Не стоит компрометировать себя и работодателя.

Но и документирующее комментирование кода может стать балластом для программиста. Как правило, это массивные участки, которые отвлекают непосредственно от программирования. Но чтобы отобразить код без комментариев, в основных IDE есть соответствующая функция. Не должна быть исключением и PhpStorm, но увы. Ищите функцию в документах обновлений.

Тег, как элемент функционала

Несмотря на то, что комментирование задумывалось как разъяснение и помощь при командной разработке, этими функциями пользуются не так часто. Как правило, теги ставят там, где хотят остановить выполнение кода. Представим, что у вас есть PHP, встроенный в HTML. И вы не хотите его cтирать, а лишь желаете посмотреть, как выглядит страница без него. Для этого необходимо соблюдать такой синтаксис:

JavaScript

…

…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div >

Как видите, простыми действиями можно остановить выполнение кода, даже не совершая какой-либо сложных операций. Но, на самом деле, это еще не верх оптимизации. Дополнительное удобство для разработчика предоставляет сама IDE phpStorm. При помощи выделения и сочетания клавиш можно закомментировать выбранный сегмент кода, не приписывая специализированные теги. Осуществить это можно так.

При помощи удобного вам способа выделяете фрагмент текста (мышь, шорткаты).

Жмите сочетание клавиш Ctr + Shift + /

Кроме этого, можно комментировать и текущую строку. Все то же, только без Shift.

Преимуществом такого вида комментирования является одновременный охват нескольких языков. PHP редко сам по себе. Таким образом, вам не нужно прибегать к проставлению тегов на каждом. Среда поддерживает еще несколько веб-языков. Лишь выделить фрагмент и продать сочетание - вот мультиязычный код и закомментирован. Точно так же его можно сделать и действующим.

На этом у нас все. Если ранее вы не пользовались этими функциями, советуем вам начать. Сокращения делают работу быстрее и качественнее.

JavaScript. Быстрый старт

Изучите основы JavaScript на практическом примере по созданию веб-приложения

В данном уроке я расскажу о том, как делаются комментарии в HTML, CSS, PHP . Комментарии представляют собой текст, который не виден на веб-странице. Они используется для разного рода пояснений, напоминаний, описаний для вебмастеров, что позволяет структурировать документ. Комментарии незаменимы при отладке кода, позволяют быстро сориентироваться в разметке веб-страницы и найти нужный блок. Часто комментарии применяются для отладки кода HTML. К примеру, можно временно закомментировать конкретный блок кода, чтобы он не исполнялся, а в случае необходимости легко его восстановить.

Комментарии в HTML

В HTML комментарии формируются с помощью символов: . Таким образом, любой текст, находящийся между этими символами, является комментарием. Рассмотрим пример:

Пример комментариев в HTML

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

Комментарии в CSS создаются с помощью символов: /* и */. Для создания комментария нужно просто поместить код-веб страницы между этими символами:

/* Начало блока со стилями для Body*/ body { background: #efeded; font-family: Verdana, Helvetica, sans-serif; font-size: 12px; margin: 0px; padding: 0px; } /* Конец блока со стилями для Body*/

Комментарии в PHP

Комментарии в PHP могут быть однострочными и многострочными:

1) Однострочные комментарии в PHP создаются с помощью символов: //. Достаточно просто поставить этот символ перед строкой и она будет закомментирована.Такой вариант применятся в том случае, когда комментарий состоит только их одной строки.

2) Для реализации многострочных комментариев используются символы: /* и */. Такой вариант полезен, если комментарий занимает несколько строк.

Таким образом, мы научились делать