PHPerKaigi 2024

ReflectionProperty::getDocComment

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

ReflectionProperty::getDocCommentGets the property doc comment

Descrição

public ReflectionProperty::getDocComment(): string|false

Gets the doc comment for a property.

Parâmetros

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

Valor Retornado

The doc comment if it exists, otherwise false.

Exemplos

Exemplo #1 ReflectionProperty::getDocComment() example

<?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
     */"

Exemplo #2 Multiple property declarations

If multiple property declarations are preceeded by a single doc comment, the doc comment refers to the first property only.

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

add a note

User Contributed Notes 1 note

up
1
Jim
1 year ago
Unfortunately, inherited doc comments are not supported.

<?php

class A {
/**
* @var string
*/
public string $prop = 'A';
}

class
B extends A {
public
string $prop = 'B';
}

$prop = new ReflectionProperty('B', 'prop');
var_dump($prop->getDocComment());

?>

results in FALSE
To Top