Комментарии в php коде и как закомментировать код. Основы PHP с нуля. Урок №4

Главная » Основы PHP » Комментарии в php коде и как закомментировать код. Основы PHP с нуля. Урок №4


25.04.2017


Комментарии в php коде и как закомментировать код. Основы PHP с нуля. Урок №4

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

Начнем!

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

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

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

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

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

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

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

Пример:


<?php
// Однострочный комментарий для PHP
# Однострочный комментарий для PHP (можно и так)
echo "Привет читателям блога - StepkinBLOG.RU!!!"; // Мое приветствие (это комментарий)
echo "<br />Подпишись на обновление"; # подписка (это комментарий)
?>

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

Привет читателям блога — StepkinBLOG.RU!!!
Подпишись на обновление

⇒ Многострочный комментарий для PHP
Многострочный комментарий для PHP начинается с символа «/*» и заканчивается символом «*/».


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

Пример:


<?php
/*
Многострочный комментарий для PHP.
Многострочный комментарий используется,
если в записи несколько строк.
*/
echo "Привет читателям блога - StepkinBLOG.RU!!!";
?>

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

Привет читателям блога — StepkinBLOG.RU!!!

P.S.: Всегда комментируйте свой код. Если вы считаете, что вспомните все, что делали в коде через 1-2 года, вы ошибаетесь, шанс очень маленький. Даже если и вспомните, то придется потратить кучу времени на изучение – что, куда и зачем…

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

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

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

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


<?php
// echo "Привет читателям блога - StepkinBLOG.RU!!!";
// echo "<br />Подпишись на обновление";
?>

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


<?php
/*
echo "Привет читателям блога - StepkinBLOG.RU!!!";
echo "<br />Подпишись на обновление";
*/
?>

В результате, вы увидите пустую страницу .

P.S.: Не спешите удалять какой-то кусок кода. Сегодня может он и не нужен будет, а завтра, возможно, придётся код дописывать .

На сегодня все!
Подписывайтесь на обновления блога, если не хотите пропустить уроки по основам PHP! 

Добавить комментарий

Добавление комментариев и разделение инструкций в PHP

Вы здесь

Главная → Блог → PHP → Добавление комментариев и разделение инструкций в PHP

Раздел: 

Наличие грамотных комментариев оказывает незаурядное влияние на удобство поддержки кода в будущем и на общую его читабельность.

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

Как добавляются комментарии в PHP?

На наш выбор предоставляется несколько способов превращения кода в комментарии:

Однострочные в стиле C++
<?php
   echo "Привет, я сложный скрипт"; // наши заметки
?>

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

Однострочные в стиле Perl
<?php
   echo " Привет, я сложный скрипт"; # наши заметки
?>

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

Многострочные в стиле C
<?php
   echo " Привет, я сложный скрипт";
   /* Длинный и замысловатый коммент
   рассказывающий что и откуда мы взяли
   в этом фрагменте скрипта, а главное
   поясняющий зачем это было сделано */
?>

Как не сложно догадаться, начинается он с «/*», а заканчивается «*/». Все, что содержится внутри этих символов считается комментарием.

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

Комментарием в этом случае будет считаться все до первой комбинации символов «*/». Не существует вложенных комментариев из разряда:

<?php
 /*
    echo " Привет, я сложный скрипт"; /* А я ошибка в коде */
 */
?>

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

Частные случаи комментирования

Если в случае использования однострочных комментариев у нас не заканчивается строка кода, но заканчивается блок PHP кода, то закончится и комментарий:

<p>Текст 1 <?php # echo "Проверка связи";?> Текст 2</p>

Да, на экране мы получим «Текст 1 Текст 2», поскольку с окончанием блока PHP заканчивается и шедший в нем комментарий.

Исключение составляет только </script>, который не закончит комментарий, а попадет в него.

Разделение инструкций в PHP

Парсеру о окончании инструкции сообщает символ «;».

<?php
   echo 'Первая инструкция';
   echo 'Вторая инструкция';
?>

Если у нас после завершения инструкции сразу же идет и окончание блока PHP, то мы можем не ставить точку с запятой, поскольку она будет проставлена автоматически.

<?php
   echo 'Первая инструкция';
?>
<?php echo 'Первая инструкция'; ?>

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

Ключевые слова: 

Основы синтаксиса PHP

Еще интересное

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

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

PHP-скрипты можно описывать с помощью комментариев. Комментарии также помогают в последующей отладке скрипта PHP.

Типы комментариев в PHP

Ниже приведены два типа комментариев, предоставляемых языком PHP.

  • Однострочные комментарии
  • Многострочные комментарии

Однострочные комментарии в PHP

Однострочные комментарии состоят из одной строки. Они начинаются с двух косых черт (//) и продолжаются до конца строки. Например:

 // Это однострочный комментарий в PHP.
// Это еще один однострочный комментарий в PHP.

Многострочные комментарии в PHP

Многострочные комментарии начинаются с /* и заканчиваются */ . Между этими двумя символами все считается комментарием. Например:

 /* Это
многострочный комментарий
в PHP.
*/

/*
это еще один
многострочный комментарий
в PHP.
*/

Примеры комментариев PHP

В следующем примере комментарии используются для описания кода PHP.

Код PHP

 ";

   /*
   Следующая строка кода
   выполняет ту же работу по печати
   текст "Привет 2"
   на выходе
   */
   напечатать «Привет 2»;
?>

Выход

 Здравствуйте!
Всем привет

Преимущества комментариев в PHP

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

Недостатки комментариев в PHP

  • Беспорядок в коде: комментарии, особенно при чрезмерном использовании, могут внести беспорядок в код. Слишком много комментариев может затруднить чтение и понимание кода.
  • Устаревшие комментарии: если комментарии не обновляются вместе с кодом, они устареют. Это особенно верно, если комментарии неточны или вводят в заблуждение.
  • Написание комментариев занимает много времени и может замедлить процесс написания кода. Чтобы сэкономить время, у программистов может возникнуть соблазн пропустить добавление комментариев, но это может привести к проблемам. позже.

Онлайн-тест PHP

« Предыдущий урокСледующий урок »


Как комментировать в PHP — с примерами .

Цель комментария — помочь другим людям понять цель написанного кода.

Комментарии полезны, потому что вы можете:

  1. Сообщать другим о назначении вашего кода
  2. Документировать части вашего кода. Напомните себе цель этого блока кода
  3. Временно отключите части вашего кода в процессе отладки

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

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

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

Комментирование также используется для удаления частей кода из выполнения. Это позволяет вам отлаживать свой код, не удаляя этот код из файла.

В PHP есть два разных способа написания комментариев:

  • Однострочный комментарий
  • Многострочные комментарии

Давайте посмотрим, как вы можете сделать и то, и другое в этом руководстве.

Чтобы создать однострочный комментарий в PHP, вам нужно добавить в код двойную косую черту ( // ) или решетку ( # ).

Рассмотрим пример ниже:

 
 Символ комментария будет помечать только весь текст справа от символа.
 Вы можете добавить код слева от комментария:
 
 Вы можете прокомментировать код, чтобы исключить его выполнение следующим образом:
 // echo "Hello World!"; // Правый комментарий
эхо «Доброе утро»;
 
 Первая функция  echo  выше закомментирована, поэтому  Hello World!  не будет напечатано при следующей обработке кода компилятором PHP.
 Вот как вы создаете однострочный комментарий. Далее давайте посмотрим, как создать многострочный комментарий.
 Чтобы создать многострочный комментарий в PHP, вам необходимо:
  1.   Открыть комментарий, используя косую черту и символ звездочки (  /*  ) 
  2.   Закрыть комментарий, используя звездочку и символ косой черты (  */  ) 
 Вот пример создания многострочных комментариев:
 
 
 В приведенном выше примере есть три строки комментариев.
 PHP также имеет расширение под названием PHPDoc, которое повышает полезность комментариев.
 Например, вы можете описать параметры, используемые в функции, используя тег  @param  следующим образом:
 
 
No related posts.