(PHP 5 >= 5.1.0, PHP 7, PHP 8)
ReflectionProperty::getDocComment — Получает doc-комментарий свойства
Метод получает doc-комментарий свойства.
Сигнатура функции не содержит параметров.
Метод возвращает doc-комментарий, если комментарий написали, иначе false.
Пример #1 Пример использования метода ReflectionProperty::getDocComment()
<?php
class Str
{
/**
* @var int Длина строки
*/
public $length = 5;
}
$prop = new ReflectionProperty('Str', 'length');
var_dump($prop->getDocComment());
?>Вывод приведённого примера будет похож на:
string(52) "/**
* @var int Длина строки
*/"
Пример #2 Объявление нескольких свойств
Doc-комментарий относится только к первому свойству, если doc-комментарий идёт перед множественным объявлением свойств.
<?php
class Foo
{
/** @var string */
public $a, $b;
}
$class = new \ReflectionClass('Foo');
foreach ($class->getProperties() as $property) {
echo $property->getName() . ': ' . var_export($property->getDocComment(), true) . PHP_EOL;
}
?>Результат выполнения приведённого примера:
a: '/** @var string */' b: false
