Комментарии в PHP — шпаргалка для начинающих

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

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

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

PHP предоставляет два способа комментирования: один — для однострочных комментариев, а второй — для многострочных.

PHP заимствует синтаксис комментариев из C, C++ и Java. Так что, если вы знакомы с ними, то сюрпризов для вас не будет.

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

Перед комментариями, которые находятся на одной строке, в PHP ставятся два символа косой черты (//).

Следующий пример содержит однострочный PHP комментарий в коде:

<?php
     // Это однострочный комментарий
?>

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

<?php
    echo "Это проверочная строка"; // Вывести строку текста
?>

В примере, приведенном выше, препроцессор PHP выполнит функцию echo и проигнорирует все, что расположено после //.

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

<?php
    // echo "Это проверочная строка";
?>

Многострочные комментарии для сайта PHP обернуты разделителями /* и */. Знак /* обозначает начало блока комментариев, а */ указывает на его конец. Следующий пример демонстрирует использование многострочного комментирования:

<?pre
/*
   Это многострочный блок 
   комментариев
*/
?>

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

Другое полезное применение многострочных комментариев — временное отключение блоков кода PHP. Распространенная практика — написать PHP-скрипт и размышлять, можно ли переписать его так, чтобы он стал более эффективным. В данной ситуации можно закомментировать старый фрагмент кода, чтобы он больше не выполнялся, и написать новый. Если окажется, что новый код хуже оригинала, то можно в PHP удалить комментарии и новый код. А затем раскомментировать старый, чтобы вернуть его в поток выполнения.

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

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

КККонстантин Кондрусинавтор статьи «Commenting PHP Code»

Урок 6. PHP — Комментарии

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

В HTML основная цель комментария в том, чтобы служить в качестве примечания разработчикам, которые могут просматривать исходный код вашего сайта. Комментарии РНР отличаются тем, что они не будут отображаться для посетителей. Единственный способ посмотреть PHP комментарии это открыть файл для редактирования. Это делает PHP комментарии полезными только для PHP — программистов.

В случае, если вы забыли или не знали, как делаются комментарии в HTML, то смотрите пример ниже.


<!-- This is an HTML Comment -->

Синтаксис php комментариев: однострочный комментарий

Тогда как в html есть только один вид комментариев, в PHP имеется целых два типа. Первый тип, который мы будем обсуждать, это однострочный комментарий. То есть комментарий, который говорит интерпретатору игнорировать все, что происходит на этой линии справа от комментариев. Для использования этого комментария следует применять символы «//» или «#» и весь текст справа будет игнорироваться интерпретатором PHP.


<?php
echo "Hello World!"; // This will print out Hello World!
echo "<br />Psst...You can't see my PHP comments!"; // echo "nothing";
// echo "My name is Humperdinkle!";
# echo "I don't do anything either";
?>

Результат:


Hello World!
Psst...You can't see my PHP comments!

Обратите внимание на то, что несколько наших команд echo не были обработаны, потому что мы закомментировали их с помощью специальных символов комментирования. Этот тип комментариев часто используется для быстрой записи о сложном и запутанном коде или чтобы временно удалить строку кода PHP (для отладки).

Синтаксис php комментариев: многострочный комментарий

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


<?php
/* This Echo statement will print out my message to the
the place in which I reside on.  In other words, the World. */
echo "Hello World!"; 
/* echo "My name is Humperdinkle!";
echo "No way! My name is Uber PHP Programmer!";
*/
?>

Результат:


Hello World!

Комментирование кода — это хорошо!

Комментирование это то, что я могу порекомендовать всем начинающим программистам РНР. Комментируйте свой код! Так много людей пишут сложный код на PHP и либо слишком ленивы, чтобы писать хорошие комментарии или считают, что комментарии не нужны. Тем не менее, вы действительно верите, что вы сможете вспомнить, что именно вы думали, когда писали этот код год или более назад?

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

← Операторы | Содержание | Include →

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

❮ Предыдущий Далее ❯

Комментарий в PHP-коде — это строка, которая не выполняется как часть программа. Его единственная цель — быть прочитанным кем-то, кто смотрит на код.

Комментарии можно использовать для:

  • Пусть другие понимают ваш код
  • Напомните себе о том, что вы сделали. Большинство программистов возвращались к своей работе через год или два, и им приходилось переосмысливать то, что они сделали. Комментарии могут напомнить вам, о чем вы думали, когда писали код

PHP поддерживает несколько способов комментирования:

Пример

Синтаксис однострочных комментариев:



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

# Это тоже однострочный комментарий
?>


< /html>

Попробуйте сами »

Пример

Синтаксис для многострочных комментариев:



/*
Это многострочный блок комментариев
, занимающий несколько
строк
*/
?>


Попробуйте сами »

Пример

Использование комментариев для пропуска частей кода:



// Вы также можете использовать комментарии, чтобы опустить часть строки кода
$x = 5 /* + 15 */ + 5;
эхо $x;
?>


Попробуйте сами »

❮ Предыдущая Далее ❯


НОВИНКА

Мы только что запустили
Видео W3Schools

Узнать

ВЫБОР ЦВЕТА
КОД ИГРЫ

Играть в игру

Лучшие учебники
Учебное пособие по HTML
Учебное пособие по CSS
Учебное пособие по JavaScript
Практическое руководство
Учебное пособие по SQL
Учебник по Python
Учебник по W3.
CSS
Учебник по Bootstrap
Учебник по PHP
Учебник по Java
Учебник по C++
Учебник по jQuery

Лучшие ссылки
HTML Reference
CSS Reference
JavaScript Reference
SQL Reference
Python Reference
W3.CSS Reference
Bootstrap Reference
PHP Reference
HTML Colors
Java Reference
Angular Reference
jQuery Reference

8 Top7 Examples Примеры HTML
Примеры CSS
Примеры JavaScript
Примеры инструкций
Примеры SQL
Примеры Python
Примеры W3.CSS
Примеры Bootstrap
Примеры PHP
Примеры Java
Примеры XML

Примеры jQuery

4 FORUM 90 | О

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

Copyright 1999-2022 Refsnes Data. Все права защищены.
W3Schools работает на основе W3.CSS.

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

Резюме : в этом руководстве вы узнаете, как использовать комментарии PHP для документирования кода.

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

PHP поддерживает два типа комментариев:

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

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

Однострочные комментарии размещаются в конце строки или в текущем блоке.

Однострочный комментарий начинается с фунта ( # ) или двойной косой черты ( // ). Остальной текст после (//) игнорируется интерпретатором PHP.

В следующем примере // используется для однострочного комментария:

 
   
  Язык кода: HTML, XML (xml)

В следующем примере используется # для однострочного комментария:

 
   
  Язык кода: HTML, XML (xml)

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

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

 
   
  Язык кода: HTML, XML (xml)

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

Написание осмысленных комментариев

Чтобы эффективно документировать свой код, используйте следующие рекомендации:

1) Чтобы код говорил сам за себя, не используя комментарии, называя осмысленные идентификаторы. Например, вы можете использовать следующее:

 
  $is_completed = true;  
  Язык кода: PHP (php)

Вместо использования загадочного имени с комментарием:

 
  $ic = true; // завершено  
  Язык кода: PHP (php)

Сам код может быть хорошим комментарием.

No related posts.