Оглавление
Однострочные комментарииМногострочные комментарииКак писать осмысленные комментарииВывод
Комментарии в PHP
Комментарии - это важная часть программного кода. Они содержат полезную информацию, которая помогает вам и другим разработчикам быстрее понять назначение кода в будущем.
PHP поддерживает два типа комментариев:
- однострочные комментарии;
- многострочные комментарии.
Однострочные комментарии
Однострочный комментарий размещается в конце строки или в текущем блоке.
Однострочный комментарий начинается с символа
# или двойного слеша //. Весь текст после этих символов игнорируется интерпретатором PHP.Пример с использованием
//:Пример с использованием
#:Многострочные комментарии
Многострочный комментарий начинается с
/* и заканчивается */.На практике многострочные комментарии используют для пояснений, занимающих несколько строк.
Как писать осмысленные комментарии
Чтобы эффективно документировать код, придерживайтесь следующих рекомендаций:
Старайтесь делать комментарии максимально краткими и по делу.
Используйте говорящие имена переменных и функций, чтобы код был понятен без дополнительных комментариев.
Например:
Вместо:
Сам код может быть лучшим комментарием.
Не объясняйте, что делает код, а объясняйте, почему
Например:
Старайтесь делать комментарии максимально краткими и по делу.
Вывод
Комментарии - это важная часть кода, потому что они объясняют, почему код делает то, что должен.
PHP поддерживает как однострочные, так и многострочные комментарии:
- Однострочный начинается с
#или//; - Многострочный — с
/*и заканчивается*/.
Базовый синтаксис PHP 8
Статья описывает основы языка PHP 8: типы данных, переменные, области видимости, управление исполнением, функции, константы, отладочные средства и преимущества строгих режимов типов. Рассчитана на начинающих разработчиков.
