ReflectionProperty::getDocComment

(PHP 5 >= 5.1.0, PHP 7)

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

Описание

public ReflectionProperty::getDocComment ( void ) : string

Получает doc-комментарий для свойства.

Список параметров

У этой функции нет параметров.

Возвращаемые значения

Doc-комментарий к свойству.

Примеры

Пример #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-комментарий задан перед множественной декларацией, то он будет считаться относящимся только к первому из них.

<?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

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