← Назад ко всем карточкам
📚
#2 13.09.2025 PHP Basics

Символы /* ... */
Расскажите об их использовании (включая документацию) и поддержке в версиях.

Это блочный комментарий, используется для многострочного текста: /* Комментарий */. Не поддерживает вложенность - вызовит ошибку.
Вариант /** */ используется для документирования кода при помощи различных аннотации @param @return и др., но это не является фичей языка, а просто общепринятое соглашение.

Подробнее
⚠️
Внимание! Этот текст был сгенерирован AI-ассистентом. Информация может содержать неточности и требует проверки.

Полный ответ:

1. Основное назначение:

  • Блочный комментарий. Игнорируется интерпретатором PHP.
  • Многострочный. Не может быть вложенным. 
    /* Это комментарий.
   Он занимает несколько строк. */

2. Специальное назначение: DocBlock

  • DocBlock — стандарт для документирования кода.
  • Начинается с /** (две звездочки!). Работает внутри /* ... */.
  • Описывает классы, методы, свойства, функции.
  • Использует аннотации (теги @param, @return, @throws и др.).

  • Нужен для IDE (подсказки, автодополнение) и генераторов документации (phpDocumentor, Doxygen).

    /**
 * Расчет суммы двух чисел
 *
 * @param int $a Первое слагаемое
 * @param int $b Второе слагаемое
 * @return int Сумма аргументов
 * @throws InvalidArgumentException Если аргументы не числа
 */
function sum($a, $b) {
    return $a + $b;
}

3. Версии PHP:

  • /* ... */ (обычный комментарий): Доступен с самой первой версии PHP (PHP 3, PHP 4). Актуален всегда.
  • /** ... */ (DocBlock): Не является фичей языка PHP. Это стандарт, разработанный сообществом.
    • phpDocumentor 1 (начало 2000-х) — популяризировал стандарт.
    • Поддержка в IDE (Zend Studio, NetBeans, позже PhpStorm) появилась давно, широко используется с эпохи PHP 5.
    • Полностью актуален для PHP 5.х, 7.х, 8.х.

4. Особенности:

  • Нет вложенности: Попытка вложить один блочный комментарий в другой вызовет ошибку. 
    /* Комментарий /* попытка вложения */ конец первого */ // ОШИБКА!
  • Не путать с # и //: Однострочные комментарии. // и # лучше для быстрых пометок, /* */ — для больших блоков и документации.