array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'reflectionproperty.getdoccomment.php', 1 => 'ReflectionProperty::getDocComment', 2 => 'Получает doc-комментарий свойства', ), 'up' => array ( 0 => 'class.reflectionproperty.php', 1 => 'ReflectionProperty', ), 'prev' => array ( 0 => 'reflectionproperty.getdefaultvalue.php', 1 => 'ReflectionProperty::getDefaultValue', ), 'next' => array ( 0 => 'reflectionproperty.gethook.php', 1 => 'ReflectionProperty::getHook', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ru', 'path' => 'reference/reflection/reflectionproperty/getdoccomment.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

ReflectionProperty::getDocComment

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

ReflectionProperty::getDocComment — Получает doc-комментарий свойства

Описание

public ReflectionProperty::getDocComment(): string|false

Метод получает 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

Смотрите также