ReflectionProperty::getDocComment

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

ReflectionProperty::getDocComment — Obtém o comentário doc da propriedade

Descrição

public ReflectionProperty::getDocComment(): string|false

Obtém o comentário doc de uma propriedade.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

O comentário doc se existir, caso contrário false.

Exemplos

Example #1 Exemplo de ReflectionProperty::getDocComment()

<?php
class Str
{
    /**
     * @var int  The length of the string
     */
    public $length = 5;
}

$prop = new ReflectionProperty('Str', 'length');

var_dump($prop->getDocComment());

?>

O exemplo acima produzirá algo semelhante a:

string(53) "/**
     * @var int  The length of the string
     */"

Example #2 Declarações de múltiplas propriedades

Se múltiplas declarações de propriedades forem precedidas por um único comentário de documento, o comentário do documento refere-se apenas à primeira propriedade. 

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

O exemplo acima produzirá:

a: '/** @var string */'
b: false

Veja Também